latestOpenAPI 3.0.02026-08-10517386.6 KB

a9f1b102faca

App installations

Get an installation

This endpoint returns a specific installation

get/app/installations/{installationId}

Path parameters

installationIdstring required

Headers

x-icr-api-versionstring

API version

Response

idstring required

The ID of the installation

createdAtstring date-time required

The creation date of the installation

updatedAtstring date-time required

The update date of the installation

permissionsobject required

The permissions of the installation

appNameIdstring required

The app name ID of the installation

appIdstring required

The app ID of the installation

accessTokensUrlstring required

The access tokens URL of the installation

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2022-01-01T00:00:00Z",
  "updatedAt": "2022-01-01T00:00:00Z",
  "organization": {
    "createdAt": "2022-01-01T00:00:00Z",
    "updatedAt": "2022-01-01T00:00:00Z",
    "fullName": "Organization 1",
    "countryCode": "US",
    "city": "New York",
    "zip": "10001",
    "physicalAddress": "123 Main St",
    "registrationNumber": "123456",
    "website": "http://example.com",
    "logo": "logo.png",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "organizationIndustries": {
      "code": "IND1",
      "name": "Industry 1"
    },
    "type": "projectProponent",
    "isPublic": true,
    "url": "https://api.carbonregistry.com/app/organizations/123e4567-e89b-12d3-a456-426614174000"
  },
  "permissions": {
    "organization_info": "VIEW",
    "organization_members": "VIEW",
    "organization_projects": "VIEW",
    "organization_inventory": "REQUEST",
    "organization_warehouse": "WRITE"
  },
  "appNameId": "app1",
  "appId": "123e4567-e89b-12d3-a456-426614174000",
  "accessTokensUrl": "https://api.carbonregistry.com/app/installations/123e4567-e89b-12d3-a456-426614174000/accessTokens"
}