Company Management

List company API keys and their usage.

List all company API keys with last usage time

get

Returns all API keys (user and team) for the company with pagination and sorting.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

companyIdstringRequired

The UUID of the company.

Query parameters

limitinteger · int32Optional

Number of records per page.

offsetinteger · int32Optional

Number of records to skip.

sort_by_fieldstring · enumOptional

Sort field: name, key_owner, last_used_at, status.

Possible values:

sort_by_orderstring · enumOptional

Sort order: asc, desc.

Possible values:

namestringOptional

Filter by API key name (partial match).

owner_uuidstringOptional

Filter by owner UUID (user or team).

Responses

200

Paginated list of all API keys for the company

application/json

totalinteger · int64OptionalExample: 10

get/v1/companies/{companyId}/api_keys/with_usage

GET /v1/companies/{companyId}/api_keys/with_usage HTTP/1.1
Host: api.nexos.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Paginated list of all API keys for the company

{
  "items": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "name": "My API Key",
      "api_key": "nexos-****1234",
      "key_owner": "John Doe",
      "owner_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "last_used_at": "2026-01-01T00:00:00.000Z",
      "status": "active",
      "type": "user",
      "budget_used": 1,
      "budget_limit": 1
    }
  ],
  "total": 10
}

List company user API keys aggregated by owner

get

Returns the company's user API keys aggregated by owner, with usage and budget information.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

companyIdstringRequired

The UUID of the company.

Query parameters

limitinteger · int32 · min: 1Optional

Maximum number of items to return.

offsetinteger · int32Optional

Number of items to skip.

sort_by_fieldstring · enumOptional

Field to sort by: owner_name, status, key_count, budget_used, budget_limit.

Possible values:

sort_by_orderstring · enumOptional

Sort order: asc, desc.

Possible values:

owner_namestringOptional

Filter by owner name (partial match).

Responses

200

Paginated list of user API key owners with keys count

application/json

totalinteger · int64OptionalExample: 1

get/v1/companies/{companyId}/users/api_keys/with_usage

GET /v1/companies/{companyId}/users/api_keys/with_usage HTTP/1.1
Host: api.nexos.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Paginated list of user API key owners with keys count

{
  "items": [
    {
      "owner_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "owner_name": "John Doe",
      "key_count": 3,
      "status": "active",
      "budget_used": 1,
      "budget_limit": 1
    }
  ],
  "total": 1
}

List user API keys with last usage time

get

Returns all API keys of a specific user in the company, with last usage time.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

companyIdstringRequired

The UUID of the company.

userIdstringRequired

The UUID of the user.

Query parameters

limitinteger · int32 · min: 1Optional

Maximum number of items to return.

offsetinteger · int32Optional

Number of items to skip.

namestringOptional

Filter by API key name (partial match).

sort_by_fieldstring · enumOptional

Field to sort by: name, owner_name, last_used_at, status, budget_limit, budget_used.

Possible values:

sort_by_orderstring · enumOptional

Sort order: asc, desc.

Possible values:

Responses

200

Paginated list of user API keys with usage

application/json

totalinteger · int64OptionalExample: 1

get/v1/companies/{companyId}/users/{userId}/api_keys/with_usage

GET /v1/companies/{companyId}/users/{userId}/api_keys/with_usage HTTP/1.1
Host: api.nexos.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Paginated list of user API keys with usage

{
  "items": [
    {
      "api_key": "nexos-3****-56iupo3240v22",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Production API Key",
      "enabled": true,
      "removed": false,
      "created_at": "2024-11-19T10:00:00Z",
      "updated_at": "2024-11-19T12:00:00Z",
      "last_used_at": "2024-11-19T12:00:00Z",
      "expiration_date": "2025-11-19T12:00:00Z",
      "owner_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "owner_name": "John Doe",
      "status": "active",
      "budget_used": 1,
      "budget_limit": 1
    }
  ],
  "total": 1
}

List company team API keys aggregated by team

get

Returns the company's team API keys aggregated by team, with usage and budget information.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

companyIdstringRequired

The UUID of the company.

Query parameters

limitinteger · int32 · min: 1Optional

Maximum number of items to return.

offsetinteger · int32Optional

Number of items to skip.

sort_by_fieldstring · enumOptional

Field to sort by: team_name, status, key_count, budget_used, budget_limit.

Possible values:

sort_by_orderstring · enumOptional

Sort order: asc, desc.

Possible values:

team_namestringOptional

Filter by team name (partial match).

Responses

200

Paginated list of team API key owners with keys count

application/json

totalinteger · int64OptionalExample: 1

get/v1/companies/{companyId}/teams/api_keys/with_usage

GET /v1/companies/{companyId}/teams/api_keys/with_usage HTTP/1.1
Host: api.nexos.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Paginated list of team API key owners with keys count

{
  "items": [
    {
      "owners": [
        {
          "owner_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "owner_name": "John Doe"
        }
      ],
      "key_count": 3,
      "team_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "team_name": "Engineering",
      "status": "active",
      "budget_used": 1,
      "budget_limit": 1
    }
  ],
  "total": 1
}

List team API keys with last usage time

get

Returns all API keys of a specific team in the company, with last usage time.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

companyIdstringRequired

The UUID of the company.

teamIdstringRequired

The UUID of the team.

Query parameters

limitinteger · int32 · min: 1Optional

Maximum number of items to return.

offsetinteger · int32Optional

Number of items to skip.

namestringOptional

Filter by API key name (partial match).

sort_by_fieldstring · enumOptional

Field to sort by: name, owner_name, last_used_at.

Possible values:

sort_by_orderstring · enumOptional

Sort order: asc, desc.

Possible values:

Responses

200

Paginated list of team API keys with usage

application/json

totalinteger · int64OptionalExample: 1

get/v1/companies/{companyId}/teams/{teamId}/api_keys/with_usage

GET /v1/companies/{companyId}/teams/{teamId}/api_keys/with_usage HTTP/1.1
Host: api.nexos.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Paginated list of team API keys with usage

{
  "items": [
    {
      "api_key": "nexos-3****-56iupo3240v22",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Production API Key",
      "enabled": true,
      "removed": false,
      "created_at": "2024-11-19T10:00:00Z",
      "updated_at": "2024-11-19T12:00:00Z",
      "last_used_at": "2024-11-19T12:00:00Z",
      "expiration_date": "2025-11-19T12:00:00Z",
      "owner_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "owner_name": "John Doe",
      "status": "active",
      "budget_used": 1,
      "budget_limit": 1
    }
  ],
  "total": 1
}