Added identity providers —
Check the API reference
LogoLogo
Other APIsChangelog
  • Welcome to Provisioning API
  • Getting started
    • API specification
    • Authorization
    • Applications
  • API reference
    • API credentials
      • The API credential object
      • Create an API credential
      • List all API credentials
      • Retrieve an API credential
      • Update an API credential
      • Delete an API credential
    • Application memberships
      • The application membership object
      • Create an application membership
      • List all application memberships
      • Retrieve an application membership
      • Update an application membership
      • Delete an application membership
    • Identity providers
      • The identity provider object
      • Create an identity provider
      • List all identity providers
      • Retrieve an identity provider
      • Update an identity provider
      • Delete an identity provider
    • Memberships
      • The membership object
      • Create a membership
      • List all memberships
      • Retrieve a membership
      • Update a membership
      • Delete a membership
    • Membership profiles
      • The membership profile object
      • Create a membership profile
      • List all membership profiles
      • Retrieve a membership profile
      • Update a membership profile
      • Delete a membership profile
    • Organizations
      • The organization object
      • Create an organization
      • List all organizations
      • Retrieve an organization
      • Update an organization
    • Permissions
      • The permission object
      • Create a permission
      • List all permissions
      • Retrieve a permission
      • Update a permission
    • Roles
      • The role object
      • Create a role
      • List all roles
      • Retrieve a role
      • Update a role
    • User
      • The user object
      • Retrieve the user
      • Update the user
    • Versions
      • The version object
      • List all versions
      • Retrieve a version
On this page
  • Request
  • Example
  • Sortable fields
  • Filterable fields
  1. API reference
  2. API credentials

List all API credentials

How to fetch a collection of API credentials via API

PreviousCreate an API credentialNextRetrieve an API credential

Last updated 8 months ago

To fetch a collection of API credentials, send a GET request to the /api/api_credentials endpoint.

Request

GET https://provisioning.commercelayer.io/api/api_credentials

Example

The following request fetches a collection of API credentials:

curl -g -X GET \
  'https://provisioning.commercelayer.io/api/api_credentials/' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer {{your_access_token}}'

On success, the API responds with a 200 OK status code, returning a paginated collection of resource objects:

{
  "data": [
    {
      "id": "xYZkjABcde",
      "type": "api_credentials",
      "links": {
        "self": "https://provisioning.commercelayer.io/api/api_credentials/xYZkjABcde"
      },
      "attributes": {
        "name": "My app",
        "kind": "sales_channel",
        "confidential": true,
        "redirect_uri": "https://bluebrand.com/img/logo.svg",
        "client_id": "xxxx-yyyy-zzzz",
        "client_secret": "xxxx-yyyy-zzzz",
        "scopes": "market:all market:9 market:122 market:6 stock_location:6 stock_location:33",
        "expires_in": 7200,
        "mode": "test",
        "custom": false,
        "created_at": "2018-01-01T12:00:00.000Z",
        "updated_at": "2018-01-01T12:00:00.000Z",
        "reference": "ANY-EXTERNAL-REFEFERNCE",
        "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
        "metadata": {
          "foo": "bar"
        }
      },
      "relationships": {
        "organization": {
          "links": {
            "self": "https://provisioning.commercelayer.io/api/api_credentials/xYZkjABcde/relationships/organization",
            "related": "https://provisioning.commercelayer.io/api/api_credentials/xYZkjABcde/organization"
          }
        },
        "role": {
          "links": {
            "self": "https://provisioning.commercelayer.io/api/api_credentials/xYZkjABcde/relationships/role",
            "related": "https://provisioning.commercelayer.io/api/api_credentials/xYZkjABcde/role"
          }
        }
      }
    },
    {
      "other": "... 9 api_credentials (first page)"
    }
  ],
  "meta": {
    "record_count": 140,
    "page_count": 14
  },
  "links": {
    "first": "https://provisioning.commercelayer.io/api_credentials?page[number]=1&page[size]=10",
    "next": "https://provisioning.commercelayer.io/api_credentials?page[number]=2&page[size]=10",
    "last": "https://provisioning.commercelayer.io/api_credentials?page[number]=14&page[size]=10"
  }
}

Remember that when you fetch a list of resources you get result.

Sortable fields

The list of API credentials can be by the following fields:

  • mode

  • id

  • created_at

  • updated_at

  • reference

  • reference_origin

Filterable fields

Attributes

  • name

  • kind

  • confidential

  • redirect_uri

  • client_id

  • scopes

  • expires_in

  • mode

  • id

  • created_at

  • updated_at

  • reference

  • reference_origin

  • metadata

Relationships

  • organization

  • role

The list of API credentials can be by the following fields:

paginated
sorted
filtered