List Users

GET

/users

Request

Query Params

string

optional

sort

enum<string>

optional

Allowed values:

createdAt-createdAt

filter

object

required

Example:

ids,<string>,<string>,userGroup,<string>,<string>,assignedMarkers,[object Object],userGroupType,<string>,<string>

ids

optional

userGroup

optional

assignedMarkers

object

optional

userGroupType

optional

limit

number

required

>= 1

offset

number

required

>= 0

include

array[string]

optional

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request GET 'https://api.synap.ac/v3/users?filter=ids,<string>,<string>,userGroup,<string>,<string>,assignedMarkers,[object Object],userGroupType,<string>,<string>&limit=&offset='

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

array[object (User) {4}]

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

User

Example:

User

attributes

object

optional

relationships

object

optional

included

array[object (GenericResource) {4}]

optional

string

optional

The primary key for each resource.

Example:

FID001

type

string

optional

Identifies the Resource.

Example:

_User

attributes

object

optional

relationships

object

optional

meta

object

optional

total

integer

required

totalWithoutFilters

integer

optional

pages

integer

required

page

integer

required

offset

integer

required

limit

integer

required

totalCount

integer

deprecated

resultCount

integer

deprecated

totalPages

integer

deprecated

currentPage

integer

deprecated

Example

{
    "data": [
        {
            "id": "FID001",
            "type": "User",
            "attributes": {
                "createdAt": "string",
                "name": "string",
                "emailAddress": "string",
                "externalId": "string",
                "profilePicture": {
                    "__type": "File",
                    "name": "string",
                    "url": "string"
                },
                "preferences": {},
                "attr": {},
                "timeZone": "string",
                "notificationConfig": {},
                "marketingEmailsConsent": "string",
                "lastSeen": "string",
                "emailVerified": true,
                "authData": {},
                "firstName": "string",
                "lastName": "string",
                "userGroupsMetadata": {
                    "property1": {
                        "dateJoined": "2019-08-24T14:15:22Z"
                    },
                    "property2": {
                        "dateJoined": "2019-08-24T14:15:22Z"
                    }
                }
            },
            "relationships": {
                "subPortal": {
                    "data": {
                        "id": "FID001",
                        "type": "SubPortal"
                    }
                },
                "userAttributes": {
                    "data": [
                        {
                            "id": "FID001",
                            "type": "UserAttribute"
                        }
                    ]
                },
                "userGroups": {
                    "data": [
                        {
                            "id": "FID001",
                            "type": "UserGroup"
                        }
                    ]
                }
            }
        }
    ],
    "included": [
        {
            "id": "FID001",
            "type": "_User",
            "attributes": {},
            "relationships": {
                "property1": {
                    "data": {
                        "id": "FID001",
                        "type": "_User"
                    },
                    "links": {
                        "self": "string",
                        "related": "string"
                    },
                    "meta": {}
                },
                "property2": {
                    "data": {
                        "id": "FID001",
                        "type": "_User"
                    },
                    "links": {
                        "self": "string",
                        "related": "string"
                    },
                    "meta": {}
                }
            }
        }
    ],
    "meta": {
        "total": 0,
        "totalWithoutFilters": 0,
        "pages": 0,
        "page": 0,
        "offset": 0,
        "limit": 0,
        "totalCount": 0,
        "resultCount": 0,
        "totalPages": 0,
        "currentPage": 0
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Modified at 2025-07-08 10:51:21

Get UserStat

Get User