Profile

Get user profile

GET /user/get Returns the profile of the currently authenticated user.

Request

Authorization

string

required

JWT Bearer token. Example: Bearer <access_token>

Response

Returns a 200 OK response with the user’s profile.

message

string

Human-readable status message. Example: "User found"

data

object

Show properties

integer

required

Unique numeric identifier for the user.

first_name

string

User’s first name.

last_name

string

User’s last name.

string

required

User’s email address.

phone_number

string

User’s phone number.

status

string

Account status. Possible values: "Awaiting Verification: User must verify their email", "Active: Verified and allowed to log in", "Suspended: Temporarily disabled by admin", "Deactivated: User closed or deleted account", "Banned: Permanently removed for violating terms".

is_superuser

boolean

required

Whether the user has superuser privileges.

Error codes

Code	Description
`400`	Malformed request.
`401`	Missing or invalid Bearer token.
`404`	User not found.
`500`	Internal server error.

Example

curl --request GET \
  --url https://api.example.com/user/get \
  --header 'Authorization: Bearer <access_token>'

Update user profile

PATCH /user/update Updates one or more fields on the authenticated user’s profile. All body fields are optional — only the fields you include will be changed.

Request

Authorization

string

required

JWT Bearer token. Example: Bearer <access_token>

Body

first_name

string

New first name.

last_name

string

New last name.

phone_number

string

New phone number. Example: "1236547899"

password

string

New password.

Response

Returns a 201 Created response with the updated user profile.

message

string

Human-readable status message. Example: "User updated successfully"

data

object

Show properties

integer

required

Unique numeric identifier for the user.

first_name

string

Updated first name.

last_name

string

Updated last name.

string

required

User’s email address.

phone_number

string

Updated phone number.

status

string

is_superuser

boolean

required

Whether the user has superuser privileges.

Error codes

Code	Description
`400`	Malformed request body or validation error.
`401`	Missing or invalid Bearer token.
`404`	User not found.
`500`	Internal server error.

Example

curl --request PATCH \
  --url https://api.example.com/user/update \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "first_name": "Jane",
    "phone_number": "1236547899"
  }'

List user companies

GET /user/companies Returns a paginated list of companies associated with the authenticated user.

This endpoint enforces an account status check. The request will be rejected if the user’s account is not active.

Request

Authorization

string

required

JWT Bearer token. Example: Bearer <access_token>

Query parameters

limit

integer

default:"10"

Number of records to return per page. Minimum 1, maximum 100.

page

integer

default:"1"

Page number to retrieve (1-indexed).

role_name

string

Filter results by the user’s role name within the company.

name

string

Filter results by company name.

description

string

Filter results by company description.

industry

string

Filter results by industry.

string

Filter results by company email address.

Response

Returns a 200 OK response with a paginated list of companies.

message

string

Human-readable status message.

data

object

Show properties

records

object[]

Array of company objects.

Show company properties

integer

required

Unique numeric identifier for the company.

name

string

Company name.

description

string

Company description.

industry

string

Industry the company operates in.

phone_number

string

Company phone number.

string

required

Company email address.

address

object

Company address.

Show address properties

street

string

Street address. Example: "123 Main St"

city

string

City. Example: "Cape Town"

state

string

State or province. Example: "CT"

postal_code

string

Postal code. Example: "8000"

country

string

Country. Example: "South Africa"

pagination

object

Pagination metadata.

Show pagination properties

total_records

integer

Total number of matching records.

limit

integer

Number of records per page.

current_page

integer

The current page number.

total_pages

integer

Total number of pages.

Error codes

Code	Description
`400`	Malformed request or validation error.
`401`	Missing or invalid Bearer token.
`403`	Account is not active.
`404`	User not found.
`500`	Internal server error.

Example

curl --request GET \
  --url 'https://api.example.com/user/companies?page=1&limit=10&industry=Technology' \
  --header 'Authorization: Bearer <access_token>'

User Endpoints

Company Endpoints

Get user profile

Request

Response

Error codes

Example

Update user profile

Request

Response

Error codes

Example

List user companies

Request

Response

Error codes

Example

Build docs developers (and LLMs) love

User Endpoints

Company Endpoints

Documentation Index

​Get user profile

​Request

​Response

​Error codes

​Example

​Update user profile

​Request

​Response

​Error codes

​Example

​List user companies

​Request

​Response

​Error codes

​Example

Build docs developers (and LLMs) love

Get user profile

Request

Response

Error codes

Example

Update user profile

Request

Response

Error codes

Example

List user companies

Request

Response

Error codes

Example