Get authenticated organization

GET

/oauth/me

const url = 'https://api.pipevest.com/v1/oauth/me';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'x-client-id': '<x-client-id>'}
};

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.pipevest.com/v1/oauth/me \
  --header 'Authorization: Bearer <token>' \
  --header 'x-client-id: <x-client-id>'

Returns the profile of the organization the token belongs to.

Authorizations

bearerAuth
clientId

Responses

200

Organization profile

application/json

object

data

object

string

name

string

description

string

nullable

website

string

nullable

email

string

nullable

phone

string

nullable

address

string

nullable

isActive

boolean

createdAt

string format: date-time

updatedAt

string format: date-time

credentials

Array<object>

object

string

name

string

clientId

string

expiresAt

string format: date-time

nullable

lastUsedAt

string format: date-time

nullable

createdAt

string format: date-time

Example

{
  "data": {
    "id": "clx0a1b2c3d4e5f6g7h8i9j0k",
    "name": "Acme Investments",
    "isActive": true
  }
}

401

Authentication failed

application/json

object

error

string

message

string

Example

{
  "error": "Unauthorized",
  "message": "Invalid organization authentication token"
}

404

Resource not found

application/json

object

error

string

message

string

Example

{
  "error": "Not found",
  "message": "Customer not found"
}