List Users

GET

https://api.synup.com/api/v4/users

This API retrieves a paginated list of all users in the system.

Pagination:

Uses cursor-based pagination for efficient data retrieval.

Returns up to 50 users per request.

Includes pageInfo for navigating through results.

Request

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.synup.com/api/v4/users' \
--header 'Authorization: API T9V35W3xxxxxxxxxxx'

Responses

🟢200OK

application/json

Successfully retrieved users

Body

Example

{
    "data": {
        "users": {
            "totalCount": 342,
            "pageInfo": {
                "hasNextPage": true,
                "hasPreviousPage": false,
                "total": 50,
                "endCursor": "VXNlcjoxNDYyNTM="
            },
            "edges": [
                {
                    "cursor": "VXNlcjoxNjUzNjA=",
                    "node": {
                        "id": "VXNlcjoxNjUzNjA=",
                        "email": "user@example.com",
                        "firstName": "John",
                        "lastName": "Doe",
                        "customRole": {
                            "id": "Q3VzdG9tUm9sZTo1OTE5",
                            "name": "District Manager(Read)"
                        },
                        "directCustomer": true,
                        "createdAt": "2025-02-03 10:25:44 UTC",
                        "inviteStatus": "ACTIVE"
                    }
                }
            ]
        }
    }
}

🟠401Unauthorized

🟠403Forbidden

Modified at 2025-07-21 09:51:44

Create User with Role

List Users by ID