Skip to content

List all project sources

Request

Lists the source of the project. A project has exactly one source, so the list always holds one item. The pagination parameters are accepted for consistency with other list operations. A source in an external Git repository includes the credentialId of the credential that Redocly uses to access the repository. Use it to rotate the access token of the credential.

Requires org.project.read permission.

Security
ApiKey
Path
orgIdstring^org_[0-9abcdefghjkmnpqrstvwxyz]{26}$required
Organization ID.
Example:org_01h1s5z6vf2mm1mz3hevnn9va7
projectIdstring^prj_[0-9abcdefghjkmnpqrstvwxyz]{26}$required
Project ID.
Example:prj_01hh1t9sa6gwfv5naz04gr7ehm
Query
afterstring

Cursor of the next page. page.nextPage contains it as the after query parameter, so you can also request page.nextPage directly. The cursor is opaque, and its internal structure is subject to change.

Example:after=a25fgaksjf23la==
beforestring

Cursor of the previous page. page.previousPage contains it as the before query parameter, so you can also request page.previousPage directly. The cursor is opaque, and its internal structure is subject to change.

Example:before=bfg23aksjf23zb1==
limitinteger, [ 1 .. 100 ]

Use to return a number of results per page. If there is more data, use in combination with after to page through the data.

Default:10
Example:limit=10
Headers
x-redocly-clientstring^[a-z0-9-]{1,64}/[\w.+-]{1,32}$

Identifies the calling client as <name>/<version>, for example reunite-ui/0.92.1. Used for API consumer observability. Requests without it are attributed as unknown.

Example:reunite-ui/0.92.1
curl -i -X GET \
  'https://redocly.com/_mock/docs/platform/customization/reunite-api/openapi/orgs/org_01h1s5z6vf2mm1mz3hevnn9va7/projects/prj_01hh1t9sa6gwfv5naz04gr7ehm/sources?after=a25fgaksjf23la%3D%3D&before=bfg23aksjf23zb1%3D%3D&limit=10' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-redocly-client: reunite-ui/0.92.1'

Responses

OK.
Bodyapplication/json
objectstringrequired
Value:"list"
pageobject(Page)required
dataArray of objects, = 1 items(ProjectSource)required
Response
{
  "object": "list",
  "page": {
    "nextPage": "/orgs/org_123/projects?limit=10&after=a25fgaksjf23la==",
    "previousPage": "/orgs/org_123/projects?limit=10&before=bfg23aksjf23zb1==",
    "limit": 10
  },
  "data": [
    { … }
  ]
}