GET
/
v5
/
app
/
companies
curl --request GET \
  --url https://{defaultHost}/v5/app/companies \
  --header 'Authorization: Bearer <token>'
{
  "pagination": {
    "current_page": 123,
    "total_pages": 123,
    "next_page": 123,
    "prev_page": 123,
    "total_count": 123
  },
  "data": [
    {
      "id": "<string>",
      "created_at": 123,
      "title": "<string>",
      "image_url": "<string>",
      "authorized_user": {
        "id": "<string>",
        "user_id": "<string>",
        "role": "owner",
        "company_id": "<string>",
        "user": {
          "id": "<string>",
          "name": "<string>",
          "username": "<string>",
          "email": "<string>",
          "profile_pic_url": "<string>",
          "created_at": 123,
          "profile_pic_url_32": "<string>",
          "profile_pic_url_64": "<string>",
          "profile_pic_url_128": "<string>"
        }
      },
      "has_payment_method": true,
      "route": "<string>",
      "owner": {
        "id": "<string>",
        "name": "<string>",
        "username": "<string>",
        "email": "<string>",
        "profile_pic_url": "<string>",
        "created_at": 123,
        "profile_pic_url_32": "<string>",
        "profile_pic_url_64": "<string>",
        "profile_pic_url_128": "<string>"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

App API key for /v5/app and /v5/company endpoints

Query Parameters

​
page
integer
default:1

The page number to retrieve

​
per
integer
default:10

The number of resources to return per page. There is a limit of 50 results per page.

Response

200 - application/json
A successful response
​
pagination
object
required
​
data
object[]
required

Was this page helpful?

OverviewRetrieve a Company