Get an organization

GET

/v1/organizations/{organization_id}

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://api.feitpay.com/v1/organizations/example"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://api.feitpay.com/v1/organizations/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.feitpay.com/v1/organizations/example \
  --header 'Authorization: Bearer <token>'

Authorizations

ApiKey
Session

Parameters

Path Parameters

organization_id

required

string

Responses

200

Organization.

application/json

object

required

string

object

required

string

Allowed value: organization

name

required

string

legal_name

required

string | null

country

required

string | null

status

required

string

Allowed values: active suspended closed

kyb_status

required

string

Allowed values: not_started draft submitted under_review needs_information approved rejected

live_enabled

required

boolean

mfa_required

required

boolean

sandbox_fixture

required

boolean

created_at

required

string format: date-time

role

required

One of:

string
null

string

Allowed values: owner admin developer finance support read_only

Example

{
  "object": "organization",
  "status": "active",
  "kyb_status": "not_started",
  "role": "owner"
}

401

Missing or invalid credentials.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

403

Authenticated but not permitted.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

404

Resource not found (or not visible to this tenant).

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

429

Too many requests. See Retry-After.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

Headers

Retry-After

integer