Sign in

v50

latestOpenAPI 3.1.0Creative Force Client Subscription Termsraw.githubusercontent.com2026-07-137852387.4 KB
Users

Retrieve a user

Retrieves the user identified by the specified slug or email address.

get/user/{user_slug}

Path parameters

string email required
OR
string required

User identifier.

Accepts either a user email or an 8-letter slug.

Headers

Accept'application/vnd.Creative Force.v2.3+json' | 'application/vnd.Creative Force.v2.3+xml' required

Defines the response type.

Response

User retrieved.

analytics_cookiesboolean

Specifies whether the user accepted analytics cookies.

broadcast_emailsboolean

Specifies whether the user accepted broadcast emails.

commentsstring

Administrative notes recorded against the user, formatted for export.

confirmationstring

Account confirmation status of the user, such as Confirmed or Invited.

confirmed_atstring date-time nullable

Date and time when the user confirmed the account. Value is null for an invited user who has not yet confirmed.

created_atstring date-time

Date and time when the user account was created.

created_bystring

Method by which the user account was created, such as manual or registration.

emailstring email nullable

Email address of the user. Value is null when no email address is recorded.

first_namestring

First name of the user.

last_namestring

Last name of the user.

marketing_cookiesboolean

Specifies whether the user accepted marketing cookies.

mobilestring

Mobile phone number of the user.

namestring

Full name of the user.

necessary_cookiesboolean

Specifies whether the user accepted necessary cookies.

notification_emailsboolean

Specifies whether the user accepted notification emails.

notification_smsboolean

Specifies whether the user accepted notification text messages.

slugstring

URL-safe identifier of the user.

updatedstring date-time

Date and time when the user account was last updated.

social_sharingboolean

Specifies whether the user opted in to social sharing.

Example response

{
  "analytics_cookies": true,
  "broadcast_emails": true,
  "comments": "Jane Doe (2025-05-21T15:25:39+00:00): User comment",
  "confirmation": "Confirmed",
  "confirmed_at": "2018-04-17T00:00:00Z",
  "created_at": "2024-06-24T06:34:30Z",
  "created_by": "manual",
  "email": "jane.doe@example.com",
  "first_name": "Jane",
  "language": {
    "code": "en_GB",
    "language": "English (United Kingdom)"
  },
  "last_name": "Doe",
  "marketing_cookies": true,
  "mobile": "",
  "name": "Jane Doe",
  "necessary_cookies": true,
  "notification_emails": true,
  "notification_sms": true,
  "preferences": {
    "broadcast_emails": true,
    "notification_emails": true,
    "notification_sms": true
  },
  "roles": [
    {
      "slug": "AbCdEfGh",
      "link": "https://api.eu.staging.cr4ce.com/role/AbCdEfGh",
      "name": {
        "en_GB": "Entrant"
      }
    },
    {
      "slug": "CdEfGhIj",
      "link": "https://api.eu.staging.cr4ce.com/role/CdEfGhIj",
      "name": {
        "en_GB": "Program manager"
      }
    }
  ],
  "slug": "EfGhIjKl",
  "social_sharing": true,
  "updated": "2026-06-26T07:50:46Z",
  "user_fields": [
    {
      "slug": "GhIjKlMn",
      "link": "https://api.eu.staging.cr4ce.com/field/GhIjKlMn",
      "label": {
        "en_GB": "<p>Title</p>"
      },
      "title": {
        "en_GB": "Title"
      },
      "value": "Ms",
      "translated": {
        "en_GB": ""
      }
    },
    {
      "slug": "IjKlMnOp",
      "link": "https://api.eu.staging.cr4ce.com/field/IjKlMnOp",
      "label": {
        "en_GB": "<p>user file upload</p>"
      },
      "title": {
        "en_GB": "user file upload"
      },
      "value": "https://api.eu.staging.cr4ce.com/file/",
      "token": "",
      "translated": {
        "en_GB": ""
      }
    }
  ]
}