Users

List users

Returns a paginated list of users in the workspace. Only users with active seat assignments are returned.

Filter by CRM id. Looks up the Nooks user mapped to the given external id in the connected CRM (e.g. a Salesforce User.Id / OwnerId).

filter[crmId] returns an empty list if no Nooks user is mapped to that id.

get/users

Request

  • Base URL: https://partner-api.nooks.in/v1
  • URL: https://partner-api.nooks.in/v1/users
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://oauth.nooks.in/oauth/authorize, token URL https://oauth.nooks.in/oauth/token, scopes: users:read)

Query parameters

page[size]integer

Number of items per page (max 100)

page[after]string

Cursor for fetching the next page. Opaque token returned by the API in links.next; callers should treat it as opaque and only pass values they received from a previous response. Malformed cursors return 400 Bad Request.

page[before]string

Cursor for fetching the previous page. Opaque token returned by the API in links.prev; callers should treat it as opaque and only pass values they received from a previous response. Malformed cursors return 400 Bad Request.

filter[name]string

Filter users by exact name match

filter[email]string email

Filter users by exact email match.

filter[crmId]string

Filter to the Nooks user mapped to the given id in the customer's CRM (e.g. a Salesforce User.Id or OwnerId). Resolved via the workspace's CRM user mappings. Returns an empty list if no Nooks user is mapped to the given id.

filter[updatedAt][gte]string date-time

Filter by minimum updatedAt (ISO 8601 datetime)

filter[updatedAt][lt]string date-time

Filter by updatedAt before this timestamp, exclusive (ISO 8601 datetime)

Response

Successful response

Example response

{
  "data": [
    {
      "id": "KKLvN5wQoghWFwUvC75CZ12QM7I3",
      "name": "Jane Doe",
      "email": "jane@example.com",
      "crmId": "0051a000000XyzABC",
      "createdAt": "2025-09-29T22:10:51.271Z",
      "updatedAt": "2025-10-07T20:42:17.281Z"
    }
  ],
  "links": {
    "first": "/v1/sequences?page[size]=50",
    "next": "/v1/sequences?page[size]=50&page[after]=eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCIsInYiOjF9"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.