Segments | Subrite

Segments

Endpoints for Segments

ReferenceUpdated October 13, 2026View as Markdown

GET/api/v1/segments

Authentication: Bearer token (JWT)

Parameters

Query parameters4

pagenumberOptional
Default: 1minimum: 1
takenumberOptional
Default: 10minimum: 1maximum: 50
orderBystringOptional
Default: "createdAt"Allowed values: "createdAt", "id", "updatedAt"
orderDirectionstringOptional
Default: "desc"Allowed values: "asc", "desc"

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExampleSegmentResponsePaginated

2 top-level fieldsSelect an object to expand

itemsarray of SegmentResponseRequired12 fields
items
- idnumberRequired when parent is presentField path: items[].id
- namestringRequired when parent is present

Example requestcurl

curl

curl https://api.subrite.no/api/v1/segments \
  --header 'Authorization: Bearer <token>'

Try it

Create a new segment#

POST/api/v1/segments

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleCreateSegmentDto

5 top-level fieldsSelect an object to expand

namestringRequired
descriptionstringOptional
statusstringRequired
Allowed values: "draft", "published"

GET/api/v1/segments/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExampleSegmentResponse

Same fields as Create a new segment (201).

DELETE/api/v1/segments/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

4 status codes

Responses 200

This response has no body.

Responses 401

PATCH/api/v1/segments/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleCreateSegmentDto

Same fields as Create a new segment (Request body).

Schema ExampleCreateSegmentDto

application/json

GET/api/v1/segments/published

Authentication: Bearer token (JWT)

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema Examplearray of Segment

15 top-level fieldsSelect an object to expand

namestringRequired when parent is present

GET/api/v1/segments/published/export-options

Authentication: Bearer token (JWT)

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema Examplearray of PublishedSegmentExportOptionResponse

3 top-level fields

GET/api/v1/segments/attributes

Authentication: Bearer token (JWT)

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema Exampleobject

No named fields are defined for this schema.

Schema Exampleobject

GET/api/v1/segments/{id}/members

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Query parameters4

pagenumberOptional
Default: 1minimum: 1
takenumberOptional
Default: 10minimum: 1maximum: 50
orderBystringOptional
Default: "createdAt"Allowed values: "createdAt"

GET/api/v1/segments/{id}/member-count

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

5 status codes

Responses 200

Status200 401 403 404 500application/json

Schema Examplenumber

No named fields are defined for this schema.

Preview segment result#

POST/api/v1/segments/preview

Authentication: Bearer token (JWT)

Parameters

Query parameters4

pagenumberOptional
Default: 1minimum: 1
takenumberOptional
Default: 10minimum: 1maximum: 50
orderBystringOptional
Default: "createdAt"Allowed values: "createdAt", "id", "updatedAt"
orderDirectionstringOptional
Default: "desc"

Schema ExampleSegmentResponsePaginated

200 · application/json

{
  "items": [
    {}
  ],
  "meta": {
    "page": 0,
    "take": 0,
    "count": 0,
    "pageCount": 0,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

Example · 13 linesShow full heightShow compact view

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is presentField path: errors[].errorType

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Schema ExampleCreateSegmentDto

application/json

{
  "name": "string",
  "description": "string",
  "status": "draft",
  "query": {
    "rules": [
      {}
    ],
    "combinator": "AND",
    "id": "string"
  },
  "type": "static"
}

Example · 13 linesShow full heightShow compact view

Responses

5 status codes

Responses 201

Status201 400 401 403 500application/json

Schema ExampleSegmentResponse

12 top-level fieldsSelect an object to expand

idnumberRequired
namestringRequired
descriptionstringRequired
queryJsonQueryRequired3 fields
query
- rulesarray of objectRequiredField path: query.rules
- combinatorstringRequiredField path: query.combinator
  Allowed values: "AND", "OR"
- idstringField path: query.id
typestringRequired
tenantIdnumberRequired
createdAtstring (date-time)Required
updatedAtstring (date-time)Required
statusstringRequired
Allowed values: "draft", "published"
adminUserNamestringRequired
adminUserEmailstringRequired
adminUserIdnumberRequired

15 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleSegmentResponse

201 · application/json

{
  "id": 0,
  "name": "string",
  "description": "string",
  "query": {
    "rules": [
      {}
    ],
    "combinator": "AND",
    "id": "string"
  },
  "type": "string",
  "tenantId": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "status": "draft",
  "adminUserName": "<adminUserName>",
  "adminUserEmail": "string",
  "adminUserId": 0
}

Example · 20 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 500application/json

shouldNotBeEmpty

Schema ExampleErrorResponse

Same fields as Get segments (403).

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 400 401 403 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get segments (403).

Responses 500

Status201 400 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get segments (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/segments \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "description": "string",
  "status": "draft",
  "query": {
    "rules": [
      {}
    ],
    "combinator": "AND",
    "id": "string"
  },
  "type": "static"
}'

SegmentResponse

200 · application/json

{
  "id": 0,
  "name": "string",
  "description": "string",
  "query": {
    "rules": [
      {}
    ],
    "combinator": "AND",
    "id": "string"
  },
  "type": "string",
  "tenantId": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "status": "draft",
  "adminUserName": "<adminUserName>",
  "adminUserEmail": "string",
  "adminUserId": 0
}

Example · 20 linesShow full heightShow compact view

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get segments (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get segments (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

{
  "name": "string",
  "description": "string",
  "status": "draft",
  "query": {
    "rules": [
      {}
    ],
    "combinator": "AND",
    "id": "string"
  },
  "type": "static"
}

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

Schema ExampleSegmentResponse

Same fields as Create a new segment (201).

Schema ExampleSegmentResponse

200 · application/json

{
  "id": 0,
  "name": "string",
  "description": "string",
  "query": {
    "rules": [
      {}
    ],
    "combinator": "AND",
    "id": "string"
  },
  "type": "string",
  "tenantId": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "status": "draft",
  "adminUserName": "<adminUserName>",
  "adminUserEmail": "string",
  "adminUserId": 0
}

Example · 20 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 500application/json

shouldNotBeEmpty

Schema ExampleErrorResponse

Same fields as Get segments (403).

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full height

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get segments (403).

Responses 500

Status200 400 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get segments (403).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/segments/{id}' \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "description": "string",
  "status": "draft",
  "query": {
    "rules": [
      {}
    ],
    "combinator": "AND",
    "id": "string"
  },
  "type": "static"
}'

adminUserUserRequired when parent is present24 fields

[].adminUser

userTypestringRequired when parent is presentField path: [].adminUser.userType
Allowed values: "system_admin", "tenant_admin", "member", "not_set"
tenantIdnumberRequired when parent is presentField path: [].adminUser.tenantId
emailstringRequired when parent is presentField path: [].adminUser.email
Can be null
fullNamestringRequired when parent is presentField path: [].adminUser.fullName
phonestringRequired when parent is presentField path: [].adminUser.phone
emailVerifiedstringRequired when parent is presentField path: [].adminUser.emailVerified
Can be null
phoneVerifiedbooleanRequired when parent is presentField path: [].adminUser.phoneVerified
isOwnerbooleanRequired when parent is presentField path: [].adminUser.isOwner
isTestUserbooleanRequired when parent is presentField path: [].adminUser.isTestUser
imagestringRequired when parent is presentField path: [].adminUser.image
createdInCheckoutUuidstringRequired when parent is presentField path: [].adminUser.createdInCheckoutUuid
userRolesarray of UserRoleField path: [].adminUser.userRoles9 fields
[].adminUser.userRoles
- userIdnumberRequired when parent is presentField path: [].adminUser.userRoles[].userId
- roleIdnumberRequired when parent is presentField path: [].adminUser.userRoles[].roleId
- userUserRequired when parent is presentField path: [].adminUser.userRoles[].userRecursive schema; nested fields are not repeated.
- roleRoleRequired when parent is presentField path: [].adminUser.userRoles[].roleNested fields omitted: depth limit.
notesarray of NoteRequired when parent is presentField path: [].adminUser.notes12 fields
[].adminUser.notes
- notestringRequired when parent is presentField path: [].adminUser.notes[].note
- memberIdstringRequired when parent is presentField path: [].adminUser.notes[].memberId
- adminUserIdnumberRequired when parent is presentField path: [].adminUser.notes[].adminUserId
- memberMemberRequired when parent is presentField path: [].adminUser.notes[].memberNested fields omitted: depth limit.
exportHistoryarray of ExportHistoryRequired when parent is presentField path: [].adminUser.exportHistoryNested fields omitted: field limit.
userSettingsUserSettingsField path: [].adminUser.userSettingsNested fields omitted: field limit.
memberMemberField path: [].adminUser.memberNested fields omitted: field limit.
tenantTenantRequired when parent is presentField path: [].adminUser.tenantNested fields omitted: field limit.
userAccountsarray of UserAccountRequired when parent is presentField path: [].adminUser.userAccountsNested fields omitted: field limit.
userSessionsarray of UserSessionRequired when parent is presentField path: [].adminUser.userSessions5 fields
[].adminUser.userSessions
- idstringRequired when parent is presentField path: [].adminUser.userSessions[].id
- expiresstringRequired when parent is presentField path: [].adminUser.userSessions[].expires
- sessionTokenstringRequired when parent is presentField path: [].adminUser.userSessions[].sessionToken
- userIdnumberRequired when parent is presentField path: [].adminUser.userSessions[].userId
idnumberRequired when parent is presentField path: [].adminUser.id
createdAtstring (date-time)Required when parent is presentField path: [].adminUser.createdAt
updatedAtstring (date-time)Required when parent is presentField path: [].adminUser.updatedAt
deletedAtstring (date-time)Required when parent is presentField path: [].adminUser.deletedAt
metaDataobjectRequired when parent is presentField path: [].adminUser.metaData

Schema Examplearray of Segment

200 · application/json

[
  {
    "name": "string",
    "description": "string",
    "query": {
      "rules": []
    },
    "type": "static",
    "status": "draft",
    "adminUserId": 0,
    "adminUser": {
      "userRoles": [],
      "notes": [],
      "exportHistory": [],
      "userAccounts": [],
      "userSessions": [],
      "metaData": {}
    },
    "tenantId": 0,
    "tenant": {
      "additionalFeatures": [],
      "disabledFeatures": [],
      "taxRates": [],
      "products": [],
      "users": [],
      "members": [],
      "roles": [],
      "subscriptionPlans": [],
      "packages": [],
      "invoices": [],
      "orders": [],
      "paymentProviders": [],
      "newslettersProviderConfig": [],
      "paymentProviderConfigs": [],
      "oidcClients": [],
      "oauthProviders": [],
      "activityLogs": [],
      "m2m_api_clients": [],
      "customProperties": [],
      "consents": [],
      "communicationTemplates": [],
      "additionalHostnames": [],
      "exportHistory": [],
      "arReportHistory": [],
      "mypageCardsSettings": [],
      "webhooks": [],
      "customOrders": [],
      "customOrderSources": [],
      "brandKits": [],
      "communicationReceivers": [],
      "metaData": {}
    },
    "segmentMembers": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  }
]

Example · 60 linesShow full heightShow compact view

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get segments (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Schema Examplearray of PublishedSegmentExportOptionResponse

200 · application/json

[
  {
    "id": 0,
    "name": "string",
    "memberCount": 0
  }
]

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get segments (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

{}

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get segments (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

, "id"

, "updatedAt"

Responses

5 status codes

Responses 200

Status200 401 403 404 500application/json

Schema ExampleSegmentMemberResponsePaginated

2 top-level fieldsSelect an object to expand

itemsarray of SegmentMemberResponseRequired6 fields
items
- idstringRequired when parent is presentField path: items[].id
- fullNamestringRequired when parent is presentField path: items[].fullName
- emailstringRequired when parent is presentField path: items[].email
- phonestringRequired when parent is presentField path: items[].phone
- memberNumbernumberRequired when parent is presentField path: items[].memberNumber
- userIdnumberRequired when parent is presentField path: items[].userId
  Can be null
metaPageMetaRequired6 fields
meta
- pagenumberRequiredField path: meta.page
- takenumberRequiredField path: meta.take
- countnumberRequiredField path: meta.count
- pageCountnumberRequiredField path: meta.pageCount
- hasPreviousPagebooleanRequiredField path: meta.hasPreviousPage
- hasNextPagebooleanRequiredField path: meta.hasNextPage

14 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleSegmentMemberResponsePaginated

200 · application/json

{
  "items": [
    {}
  ],
  "meta": {
    "page": 0,
    "take": 0,
    "count": 0,
    "pageCount": 0,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

Example · 13 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get segments (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 lines

Responses 404

Status200 401 403 404 500application/json

segmentNotFound

SchemaErrorResponse

Same fields as Get segments (403).

Responses 500

Status200 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get segments (403).

Responses 403

Status200 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get segments (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Request body

Required bodyapplication/json

Schema ExampleJsonQuery

3 top-level fields

rulesarray of objectRequired
combinatorstringRequired
Allowed values: "AND", "OR"
idstringOptional

3 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleJsonQuery

application/json

{
  "rules": [
    {}
  ],
  "combinator": "AND",
  "id": "string"
}

Example · 7 linesShow full heightShow compact view

Responses

5 status codes

Responses 200

Status200 201 401 403 500application/json

Schema ExampleMemberPaginated

2 top-level fieldsSelect an object to expand

itemsarray of MemberRequired21 fields
items
- userIdnumberRequired when parent is presentField path: items[].userId
  Can be null
- memberNumbernumberRequired when parent is presentField path: items[].memberNumber
  Can be null
- tenantIdnumberRequired when parent is presentField path: items[].tenantId
- externalIdstringRequired when parent is presentField path: items[].externalId
  Can be null
- fullNamestringRequired when parent is presentField path: items[].fullName
- nickNamestringRequired when parent is presentField path: items[].nickName
- avatarstringRequired when parent is presentField path: items[].avatar
- emailstringRequired when parent is presentField path: items[].email
- birthDatestring (date-time)Required when parent is presentField path: items[].birthDate
  Can be null
- phonestringRequired when parent is presentField path: items[].phone
- isCompanybooleanRequired when parent is presentField path: items[].isCompany
- companyNamestringRequired when parent is presentField path: items[].companyName
  Can be null
- organizationNostringRequired when parent is presentField path: items[].organizationNo
  Can be null
- deleteAfterExpirationbooleanRequired when parent is presentField path: items[].deleteAfterExpiration
- customPropertyValuesobjectRequired when parent is presentField path: items[].customPropertyValues
- productRecipientsarray of MemberPackageProductRecipientRequired when parent is presentField path: items[].productRecipients9 fields
  items[].productRecipients
  - memberPackageProductIdnumberRequired when parent is presentField path: items[].productRecipients[].memberPackageProductId
  - memberIdstringRequired when parent is presentField path: items[].productRecipients[].memberId
  - memberPackageProductMemberPackageProductRequired when parent is presentField path: items[].productRecipients[].memberPackageProductNested fields omitted: depth limit.
  - memberMember
- idstringRequired when parent is presentField path: items[].id
- createdAtstring (date-time)Required when parent is presentField path: items[].createdAt
- updatedAtstring (date-time)Required when parent is presentField path: items[].updatedAt
- deletedAtstring (date-time)Required when parent is presentField path: items[].deletedAt
- metaDataobjectRequired when parent is presentField path: items[].metaData
metaPageMetaRequired6 fields
meta
- pagenumberRequiredField path: meta.page
- takenumberRequiredField path: meta.take
- countnumberRequiredField path: meta.count
- pageCountnumberRequiredField path: meta.pageCount
- hasPreviousPagebooleanRequiredField path: meta.hasPreviousPage
- hasNextPagebooleanRequiredField path: meta.hasNextPage

38 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleMemberPaginated

200 · application/json

{
  "items": [
    {
      "customPropertyValues": {},
      "productRecipients": [],
      "metaData": {}
    }
  ],
  "meta": {
    "page": 0,
    "take": 0,
    "count": 0,
    "pageCount": 0,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

Example · 17 linesShow full heightShow compact view

Responses 201

This response has no body.

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 201 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get segments (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 lines

Responses 500

Status200 201 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get segments (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/segments/preview \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "rules": [
    {}
  ],
  "combinator": "AND",
  "id": "string"
}'

adminUser

User

Get segments#

Parameters

Responses

Responses 200

Create a new segment#

Request body

Get a segment by id#

Parameters

Responses

Responses 200

Delete a segment#

Parameters

Responses

Responses 200

Responses 401

Update a segment#

Parameters

Request body

Get all published segments#

Responses

Responses 200

Get published segments with member counts for the list-export picker#

Responses

Responses 200

Get segmentation entity and attributes#

Responses

Responses 200

Get members of a segment#

Parameters

Get member count of a segment#

Parameters

Responses

Responses 200

Preview segment result#

Parameters

Get segments#

Parameters

Responses

Responses 200

Create a new segment#

Request body

Get a segment by id#

Parameters

Responses

Responses 200

Delete a segment#

Parameters

Responses

Responses 200

Responses 401

Update a segment#

Parameters

Request body

Get all published segments#

Responses

Responses 200

Get published segments with member counts for the list-export picker#

Responses

Responses 200

Get segmentation entity and attributes#

Responses

Responses 200

Get members of a segment#

Parameters

Get member count of a segment#

Parameters

Responses

Responses 200

Preview segment result#

Parameters

Responses 401

Responses 403

Responses 500

Responses

Responses 201

Responses 400

Responses 401

Responses 403

Responses 500

Responses 401