Get a project

GET

/orgs/{org}/projects/{id}

curl --request GET \
  --url https://api.sloose.com/orgs/org_9f3c/projects/b3f1c8a2 \
  --header 'Authorization: Bearer <token>'

• Production
• Staging

The project with its configuration, migrated forward on read. migrated lists the steps that were applied — non-empty means the stored row was written by an older build and will be rewritten on the next save.

Authorizations

• sessionAuth
• apiTokenAuth

Parameters

Path Parameters

org

required

The org id the session was issued for. A token for one org can never read another.

string

Example

org_9f3c

The org id the session was issued for. A token for one org can never read another.

id

required

The project id.

string

Example

b3f1c8a2

The project id.

Responses

200

The project.

Media typeapplication/json

object

project

required

object

id

required

string

orgId

required

string

connectorId

required

The destination this project imports into. Null means the org’s default CRM: a project from before connectors were named, or one saved by an API token or an older session, which name no connector.

string | null

name

required

string

description

required

string | null

createdByUserId

required

string

visibility

required

string

Allowed values: private org

schemaVersion

required

number

enabledModules

required

Array<string>

libraryVersions

required

object | null

registryVersion

required

number | null

sourceRef

required

bundle:<file> when pushed from a config repo; null when built by a person.

string | null

createdAt

required

string

updatedAt

required

string

config

required

Migrated to the current schema version on read. Null when it could not be migrated.

object | null

migrated

required

Migration steps applied on read. Non-empty means the stored row is from an older build.

Array<string>

unreadable

required

string | null

Example

{
  "project": {
    "visibility": "private"
  }
}

401

No bearer, or one that is expired, revoked or no longer resolves to a member.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

403

The bearer’s role is too low, or it was issued for a different org.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

404

No such project, or it is not visible to this session.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}