List Accounts

Returns a paginated list of accounts the authenticated user has access to. Results can be filtered by name.

get/accounts

Request

Base URL
https://www.harborcompliance.com/api/v1
Auth
OAuth 2
Authorization code/api/v1/oauth/authorize
Token URL/api/v1/oauth/access_token
TypeScript
https://skmtc.dev/harborcompliance/apis/harbor-compliance-api/docs/accounts/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

limitinteger

Maximum number of results per page

pageinteger

Page number to retrieve

includestring[]

Comma-separated list of related resources to include for accounts.

filter[name]string

Example:Acme Corporation

Filter accounts by exact name match.

Response

Success

has_moreboolean

Indicates if there are more results available beyond the current page.

Example response

{
  "data": [
    {
      "billing_address": {
        "administrative_area": {
          "id": "123e4567-e89b-12d3-a456-426614174000"
        },
        "country": {
          "id": "123e4567-e89b-12d3-a456-426614174000"
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.