Get a design library

GET

https://api.contentful.com/spaces/:spaceId/design_libraries/:designLibraryId

GET

/spaces/:spaceId/design_libraries/:designLibraryId

curl https://api.contentful.com/spaces/spaceId/design_libraries/designLibraryId \
     -H "Authorization: Bearer <token>"

{
  "sys": {
    "id": "string",
    "type": "string",
    "basedOn": {
      "concept": {
        "sys": {
          "id": "string",
          "linkType": "string",
          "type": "string"
        }
      },
      "environment": {
        "sys": {
          "id": "string",
          "linkType": "string",
          "type": "string"
        }
      }
    },
    "createdAt": "string",
    "createdBy": {
      "sys": {
        "id": "string",
        "linkType": "string",
        "type": "string"
      }
    },
    "space": {
      "sys": {
        "id": "string",
        "linkType": "string",
        "type": "string"
      }
    },
    "updatedAt": "string",
    "updatedBy": {
      "sys": {
        "id": "string",
        "linkType": "string",
        "type": "string"
      }
    },
    "version": 1
  },
  "name": "string",
  "description": "string",
  "sharedWithSpaces": "string",
  "recommendedVersion": {
    "sys": {
      "type": "string",
      "linkType": "string",
      "id": "string"
    }
  }
}

Retrieves a design library owned by the space or shared with it from the same organisation.

The response includes:

A link to the environment the design library is based on.
Sharing settings that identify the spaces that can read and install the library.
A link to the recommended design library version, or null if no recommendation is set.

Authentication

AuthorizationBearer

Contentful Management API token

Path parameters

spaceIdstringRequired

designLibraryIdstringRequired

Response

200

sysobject

namestring

descriptionstring or null

sharedWithSpaces"*" or list of strings

recommendedVersionobject or null

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

500

Internal Server Error