Get Repository

Retrieves basic information for the requested repository, provided the user has at least read-only access.

get/v1/repositories/{repositoryId}

Request

Base URL
https://api.lucid.co
Auth
- HTTP bearer
- or OAuth 2
  Authorization codehttps://lucid.app/oauth2/authorize
  Token URLhttps://api.lucid.co/oauth2/token
  Scopesrepository:readonly
TypeScript
https://skmtc.dev/lucid/apis/lucid-rest-api/docs/v1/repositories/:repositoryId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

repositoryIdstring required

Unique identifier for a repository folder, prefixed with repo_

Example:repo_1234321

The unique identifier of the repository

Response

OK. Returns the repository object.

repositoryIdstring

Unique identifier for a repository folder, prefixed with repo_

namestring

Display name of the repository

accessType'UNRESTRICTED' | 'RESTRICTED'

Determines repository visibility. UNRESTRICTED repositories are visible to all users on the account, RESTRICTED are visible to specific authorized groups and individuals.

createdstring date-time

The date and time the repository was created

Example response

{
  "repositoryId": "repo_1234321",
  "name": "My Business Process Repository",
  "accessType": "UNRESTRICTED",
  "created": "2022-11-11T21:48:35.293Z"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.