Skip to main content
GET
The response includes all user fields. File fields include a download link.

Authorizations

x-api-key
string
header
required

API key used to authenticate and authorise every request. Include it in the x-api-key header.

Headers

Accept
enum<string>
required

Defines the response type.

Available options:
application/vnd.Creative Force.v2.3+json,
application/vnd.Creative Force.v2.3+xml

Path Parameters

user_slug
required

User identifier.

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

Response

User retrieved.

Detailed user fields returned only for a single user.

analytics_cookies
boolean

Specifies whether the user accepted analytics cookies.

broadcast_emails
boolean

Specifies whether the user accepted broadcast emails.

comments
string

Administrative notes recorded against the user, formatted for export.

confirmation
string

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

confirmed_at
string<date-time> | null

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

created_at
string<date-time>

Date and time when the user account was created.

created_by
string

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

email
string<email> | null

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

first_name
string

First name of the user.

language
object

Preferred language of the user.

last_name
string

Last name of the user.

marketing_cookies
boolean

Specifies whether the user accepted marketing cookies.

mobile
string

Mobile phone number of the user.

name
string

Full name of the user.

necessary_cookies
boolean

Specifies whether the user accepted necessary cookies.

notification_emails
boolean

Specifies whether the user accepted notification emails.

notification_sms
boolean

Specifies whether the user accepted notification text messages.

roles
object[]

Roles assigned to the user within the account.

slug
string

URL-safe identifier of the user.

updated
string<date-time>

Date and time when the user account was last updated.

preferences
object

Notification preferences selected by the user.

social_sharing
boolean

Specifies whether the user opted in to social sharing.

user_fields
object[]

Custom field responses captured on the user profile.