Get the user information for the authenticated user.

Alternatively, you can also use the `/users/me` endpoint.

Access-Control-Allow-Headers header. This is a comma-separated list of headers.

The Content-Location header for responses that are not the final destination. This is used to indicate where the resource can be found, when it is finished.

The location header for redirects and letting users know if there is a websocket they can listen to for status updates on their operation.

ID for this request. We return it so that users can report this to us and help us debug their problems.

Get your user.

This endpoint requires authentication by any Zoo user. It updates information about the authenticated user.

Update your user.

This endpoint requires authentication by any Zoo user. It deletes the authenticated user from Zoo's database.

This call will only succeed if all invoices associated with the user have been paid in full and there is no outstanding balance.

Delete your user.

Request body for authenticated website CAD user info form submissions.

Gets authenticated CAD user info form data for the current user.

This endpoint requires authentication by any Zoo user. It accepts a structured client error payload and writes it to the server logs for triage.

Structured client-side error report sent by authenticated clients.

Response acknowledging that the error report was accepted for logging.

Report a CLIent-originated error.

Public view of an authenticated user's email marketing consent state.

Get email marketing consent state for the authenticated user.

Record explicit decline for email marketing consent.

Request email marketing opt-in and send a confirmation email.

Mark the email-marketing modal as seen/dismissed for the authenticated user.

Get the user information for the authenticated user.

Alternatively, you can also use the `/users-extended/me` endpoint.

Extended user information.

This is mostly used for internal purposes. It returns a mapping of the user's information, including that of our third party services we use for users: Stripe

Get extended information about your user.

Returns only features that are marked as safe for exposure to clients and currently resolved to `true` for the requesting user (including org overrides).

List user-visible feature flags enabled for the authenticated user.

This endpoint requires authentication by any Zoo user. It lists the authenticated user's active public OAuth apps.

Maximum number of items returned by a single call

limit

Token returned by previous call to retrieve the subsequent page

page_token

sort_by

Supported set of sort modes for scanning by created_at only.

Currently, we only support scanning in ascending order.

Sort in increasing order of "created_at".

Sort in decreasing order of "created_at".

List personal OAuth apps.

This endpoint requires authentication by any Zoo user. It creates an active public OAuth app owned by the authenticated user.

Request body for creating a public OAuth app.

Create a personal OAuth app.

This endpoint requires authentication by any Zoo user. It returns the authenticated user's active public OAuth app by client ID.

client_id

Get a personal OAuth app.

This endpoint requires authentication by any Zoo user. It updates the configuration of the authenticated user's active public OAuth app.

Request body for updating a public OAuth app.

Update a personal OAuth app.

This endpoint requires authentication by any Zoo user. It deactivates the authenticated user's active public OAuth app.

Delete a personal OAuth app.

If this returns an empty array, then the user has not connected any OAuth2 providers and uses raw email authentication.

This endpoint requires authentication by any Zoo user. It gets the providers for the authenticated user.

Array_of_AccountProvider

Get the OAuth2 providers for your user.

This endpoint requires authentication by any Zoo user. It gets the authenticated user's org.

If the user is not a member of an org, this endpoint will return a 404.

A user's information about an org, including their role.

Get a user's org.

This endpoint requires authentication by any Zoo user. It gets the privacy settings for the user.

Get the privacy settings for a user.

This endpoint requires authentication by any Zoo user. It updates the privacy settings for the user.

Update the user's privacy settings.

This endpoint requires authentication by any Zoo user. It returns details of the requested API token for the user.

token

An auth token. A uuid with a prefix of ses-

Get a session for your user.

This endpoint requires authentication by any Zoo user. It gets the shortlinks for the user.

Get the shortlinks for a user.

This endpoint requires authentication by any Zoo user. It creates a shortlink for the user.

Create a shortlink for a user.

This endpoint might require authentication by a Zoo user. It gets the shortlink for the user and redirects them to the URL. If the shortlink is owned by an org, the user must be a member of the org.

Redirect the user to the URL for the shortlink.

This endpoint requires authentication by any Zoo user. It updates a shortlink for the user.

This endpoint really only allows you to change the `restrict_to_org` setting of a shortlink. Thus it is only useful for folks who are part of an org. If you are not part of an org, you will not be able to change the `restrict_to_org` status.

Update a shortlink for a user.

This endpoint requires authentication by any Zoo user. It deletes a shortlink for the user.

Delete a shortlink for a user.

To get information about yourself, use `/users-extended/me` as the endpoint. By doing so you will get the user information for the authenticated user.

Alternatively, to get information about the authenticated user, use `/user/extended` endpoint.

Get extended information about a user.

To get information about yourself, use `/users/me` as the endpoint. By doing so you will get the user information for the authenticated user.

Alternatively, to get information about the authenticated user, use `/user` endpoint.

Get a user.

Zoo admins can retrieve extended information about any user, while non-admins receive a 404 to avoid leaking the existence of the resource.

Get admin-only details for a user.

You must be a Zoo admin to perform this request.

A struct of Zoo product subscriptions a user can request.

Update a subscription for a user.

The data for subscribing a user to the newsletter.

Requests public email marketing consent for an email address.

slug

Request body for public mailing-list membership changes.

Publicly subscribe an email address to a mailing list by slug.

Publicly remove an email address from a mailing list by slug.

Stores authenticated CAD user info form data for the current user.

This endpoint accepts optional authentication.

Request body for website sales form submissions.

Creates a new sales ticket in the internal help desk from the website sales form.

Request body for website support form submissions.

Creates a new support ticket in the internal help desk from the website support form.

A user is someone who uses the Zoo API. Here, we can create, delete, and list users. We can also get information about a user. Operations will only be authorized if the user is requesting information about themselves.

Users

Endpoints