Skip to main content
GET
/
api
/
v3
/
companies
List companies
curl --request GET \
  --url https://paradigm.lighton.ai/api/v3/companies \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "results": [
    {
      "id": 123,
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "dpo_email": "jsmith@example.com",
      "max_users": -1,
      "login_method": "password"
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer

Page number (default: 1)

​
search
string

Filter by company name (case-insensitive)

Response

List of companies with DRF pagination (count, next, previous, results)

​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"