Retrieve an Organisation profile info

GET 
/v1/organisations/:id/profile

Retrieve an Organisation profile info

Request

Path Parameters

id stringrequired

Id of the organisation

Responses

200

Retrieve a nonprofit Organisation profile

application/json

Schema

Schema

data

object

name string

Example: Lemon rescue nonprofit

displayName stringnullable

Example: Lemon Team

description stringnullable

Example: Lemon Team

logo stringnullable

Example: https://logo-url.com/the-logo.png
object string
Example: organisation_profile

Example (from schema)

{
  "data": {
    "name": "Lemon rescue nonprofit",
    "displayName": "Lemon Team",
    "description": "Lemon Team",
    "logo": "https://logo-url.com/the-logo.png"
  },
  "object": "organisation_profile"
}

404

The specified resource was not found

application/json

Schema

Schema

error

object

code string

Example: not_found

title string

Example: Resource not found

message string

Example: This endpoint is unavailable or can not be found

Example (from schema)

{
  "error": {
    "code": "not_found",
    "title": "Resource not found",
    "message": "This endpoint is unavailable or can not be found"
  }
}

Loading...