Get organization by ID

GET 
https://api.astropulse.io/api/v1/organizations/:id

Get organization details by ID

Request

Path Parameters

id stringrequired

Organization ID

Header Parameters

X-Astro-API-Key stringrequired

APIKey

Responses

200

Organization details retrieved successfully

application/json

Schema

Schema

data object
createdAtstring
idstring
members object[]
Array [
joinedAtstring
rolestring
userIdstring
]
namestring
orgNamespacestring
ownerboolean
ownerUserIdstring
planIdstring
roles object[]
Array [
idstring
namestring
permissions object[]
Array [
descriptionstring
idstring
namestring
]
]
slugstring
titlestring
userRolestring
idstring
messagestring
statusstring

Example (auto)

{
  "data": {
    "createdAt": "string",
    "id": "string",
    "members": [
      {
        "joinedAt": "string",
        "role": "string",
        "userId": "string"
      }
    ],
    "name": "string",
    "orgNamespace": "string",
    "owner": true,
    "ownerUserId": "string",
    "planId": "string",
    "roles": [
      {
        "id": "string",
        "name": "string",
        "permissions": [
          {
            "description": "string",
            "id": "string",
            "name": "string"
          }
        ]
      }
    ],
    "slug": "string",
    "title": "string",
    "userRole": "string"
  },
  "id": "string",
  "message": "string",
  "status": "string"
}

400

Invalid request parameters

application/json

Schema

Schema

body object
Error response in: body
detailsobject
errorstring
Example: Resource not found
error_codestring
Example: NOT_FOUND
statusinteger
Example: 404
trace_idstring
Example: trace-5e6f7g8h9i

Example (auto)

{
  "body": {
    "details": {},
    "error": "Resource not found",
    "error_code": "NOT_FOUND",
    "status": 404,
    "trace_id": "trace-5e6f7g8h9i"
  }
}

401

Missing or invalid API key

application/json

Schema

Schema

body object
Error response in: body
detailsobject
errorstring
Example: Resource not found
error_codestring
Example: NOT_FOUND
statusinteger
Example: 404
trace_idstring
Example: trace-5e6f7g8h9i

Example (auto)

{
  "body": {
    "details": {},
    "error": "Resource not found",
    "error_code": "NOT_FOUND",
    "status": 404,
    "trace_id": "trace-5e6f7g8h9i"
  }
}

403

User does not have permission to access this organization

application/json

Schema

Schema

body object
Error response in: body
detailsobject
errorstring
Example: Resource not found
error_codestring
Example: NOT_FOUND
statusinteger
Example: 404
trace_idstring
Example: trace-5e6f7g8h9i

Example (auto)

{
  "body": {
    "details": {},
    "error": "Resource not found",
    "error_code": "NOT_FOUND",
    "status": 404,
    "trace_id": "trace-5e6f7g8h9i"
  }
}

404

Organization not found

application/json

Schema

Schema

body object
Error response in: body
detailsobject
errorstring
Example: Resource not found
error_codestring
Example: NOT_FOUND
statusinteger
Example: 404
trace_idstring
Example: trace-5e6f7g8h9i

Example (auto)

{
  "body": {
    "details": {},
    "error": "Resource not found",
    "error_code": "NOT_FOUND",
    "status": 404,
    "trace_id": "trace-5e6f7g8h9i"
  }
}

429

Rate limit exceeded

application/json

Schema

Schema

body object
Error response in: body
detailsobject
errorstring
Example: Resource not found
error_codestring
Example: NOT_FOUND
statusinteger
Example: 404
trace_idstring
Example: trace-5e6f7g8h9i

Example (auto)

{
  "body": {
    "details": {},
    "error": "Resource not found",
    "error_code": "NOT_FOUND",
    "status": 404,
    "trace_id": "trace-5e6f7g8h9i"
  }
}

500

Internal server error

application/json

Schema

Schema

body object
Error response in: body
detailsobject
errorstring
Example: Resource not found
error_codestring
Example: NOT_FOUND
statusinteger
Example: 404
trace_idstring
Example: trace-5e6f7g8h9i

Example (auto)

{
  "body": {
    "details": {},
    "error": "Resource not found",
    "error_code": "NOT_FOUND",
    "status": 404,
    "trace_id": "trace-5e6f7g8h9i"
  }
}

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.astropulse.io/api/v1/organizations/:id");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.astropulse.io

Parameters

id — pathrequired

X-Astro-API-Key — headerrequired