WebsiteChangelogBook a Demo

Directory

Directory module endpoints

List accounts

get
Authorizations
Responses
200
OK
application/json
get
GET /api/v1/account HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*
200

OK

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "text",
    "name": "text",
    "active": true,
    "status": {
      "current": "text",
      "changedAt": "2025-07-02T00:52:01.445Z",
      "changedBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "created": {
      "createdAt": "2025-07-02T00:52:01.445Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "mappings": [
      {
        "app": "123e4567-e89b-12d3-a456-426614174000",
        "namespace": "text",
        "mappedId": "text",
        "reference": "text",
        "mappingData": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "mappingSecrets": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ],
    "preferences": {
      "namespace": "text",
      "values": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "grants": [
      {
        "orgId": "123e4567-e89b-12d3-a456-426614174000",
        "role": "text",
        "employeeId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  }
]

Create account

post
Authorizations
Body
namestringOptional
emailstringRequired
Responses
201
Created
application/json
post
POST /api/v1/account HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "name": "text",
  "email": "text"
}
201

Created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "text",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-02T00:52:01.445Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-02T00:52:01.445Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "preferences": {
    "namespace": "text",
    "values": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "grants": [
    {
      "orgId": "123e4567-e89b-12d3-a456-426614174000",
      "role": "text",
      "employeeId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Get account by ID or email

get
Authorizations
Path parameters
accountIdOrEmailstringRequired
Responses
200
OK
application/json
get
GET /api/v1/account/{accountIdOrEmail} HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "text",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-02T00:52:01.445Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-02T00:52:01.445Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "preferences": {
    "namespace": "text",
    "values": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "grants": [
    {
      "orgId": "123e4567-e89b-12d3-a456-426614174000",
      "role": "text",
      "employeeId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Update account

patch
Authorizations
Path parameters
accountIdOrEmailstringRequired
Body
namestringOptional
emailstringRequired
Responses
200
OK
application/json
patch
PATCH /api/v1/account/{accountIdOrEmail} HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "name": "text",
  "email": "text"
}
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "text",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-02T00:52:01.445Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-02T00:52:01.445Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "preferences": {
    "namespace": "text",
    "values": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "grants": [
    {
      "orgId": "123e4567-e89b-12d3-a456-426614174000",
      "role": "text",
      "employeeId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Grant account a role

post
Authorizations
Path parameters
accountIdstringRequired
Body
orgIdstring · uuidOptional
rolestringRequired
employeeIdstring · uuidOptional
Responses
200
OK
application/json
post
POST /api/v1/account/{accountId}/grant HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 114

{
  "orgId": "123e4567-e89b-12d3-a456-426614174000",
  "role": "text",
  "employeeId": "123e4567-e89b-12d3-a456-426614174000"
}
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "text",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-02T00:52:01.445Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-02T00:52:01.445Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "preferences": {
    "namespace": "text",
    "values": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "grants": [
    {
      "orgId": "123e4567-e89b-12d3-a456-426614174000",
      "role": "text",
      "employeeId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

List organization admins

get
Authorizations
Responses
200
OK
application/json
get
GET /api/v1/account/org-admins HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*
200

OK

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "text",
    "name": "text",
    "active": true,
    "status": {
      "current": "text",
      "changedAt": "2025-07-02T00:52:01.445Z",
      "changedBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "created": {
      "createdAt": "2025-07-02T00:52:01.445Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "mappings": [
      {
        "app": "123e4567-e89b-12d3-a456-426614174000",
        "namespace": "text",
        "mappedId": "text",
        "reference": "text",
        "mappingData": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "mappingSecrets": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ],
    "preferences": {
      "namespace": "text",
      "values": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "grants": [
      {
        "orgId": "123e4567-e89b-12d3-a456-426614174000",
        "role": "text",
        "employeeId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  }
]

List employees for account

get
Authorizations
Path parameters
accountIdstringRequired
Responses
200
OK
application/json
get
GET /api/v1/account/{accountId}/employees HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*
200

OK

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "active": true,
    "status": {
      "current": "text",
      "changedAt": "2025-07-02T00:52:01.445Z",
      "changedBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "created": {
      "createdAt": "2025-07-02T00:52:01.445Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "emails": [
      {
        "email": "text",
        "primary": true
      }
    ],
    "groups": [
      {
        "entityType": "text",
        "entityId": "123e4567-e89b-12d3-a456-426614174000",
        "type": "text"
      }
    ],
    "managers": [
      {
        "managerId": "123e4567-e89b-12d3-a456-426614174000",
        "type": "text",
        "since": "2025-07-02T00:52:01.445Z"
      }
    ],
    "profile": {
      "employeeNumber": "text",
      "firstName": "text",
      "lastName": "text",
      "bio": "text",
      "profileImage": "text",
      "birthDate": "2025-07-02",
      "gender": "text",
      "timezone": "text",
      "location": "text",
      "joinDate": "2025-07-02",
      "companyRole": "text"
    },
    "account": "123e4567-e89b-12d3-a456-426614174000",
    "authentication": {
      "account": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-07-02T00:52:01.445Z",
      "email": "text",
      "role": "text"
    },
    "preferences": {
      "namespace": "text",
      "values": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "mappings": [
      {
        "app": "123e4567-e89b-12d3-a456-426614174000",
        "namespace": "text",
        "mappedId": "text",
        "reference": "text",
        "mappingData": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "mappingSecrets": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ]
  }
]

List accounts for organization

get
Authorizations
Responses
200
OK
application/json
get
GET /api/v1/account/for-org HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*
200

OK

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "text",
    "name": "text",
    "active": true,
    "status": {
      "current": "text",
      "changedAt": "2025-07-02T00:52:01.445Z",
      "changedBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "created": {
      "createdAt": "2025-07-02T00:52:01.445Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "mappings": [
      {
        "app": "123e4567-e89b-12d3-a456-426614174000",
        "namespace": "text",
        "mappedId": "text",
        "reference": "text",
        "mappingData": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "mappingSecrets": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ],
    "preferences": {
      "namespace": "text",
      "values": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "grants": [
      {
        "orgId": "123e4567-e89b-12d3-a456-426614174000",
        "role": "text",
        "employeeId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  }
]

Get entity groups

get
Authorizations
Path parameters
entitystringRequired
Responses
200
OK
application/json
get
GET /api/v1/entity/{entity}/groups HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*
200

OK

[
  {
    "entityType": "text",
    "entityId": "123e4567-e89b-12d3-a456-426614174000",
    "type": "text"
  }
]

Set groups for entity

post
Authorizations
Path parameters
entitystringRequired
Body
groupIdstring · uuidOptional
typestringOptional
Responses
200
OK
post
POST /api/v1/entity/{entity}/groups HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 66

[
  {
    "groupId": "123e4567-e89b-12d3-a456-426614174000",
    "type": "text"
  }
]
200

OK

No content

Remove entity from group

delete
Authorizations
Path parameters
entitystringRequired
groupstringRequired
Responses
200
OK
delete
DELETE /api/v1/entity/{entity}/groups/{group} HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*
200

OK

No content

List employees

get
Authorizations
Query parameters
statusstringOptional
typestringOptional
Responses
200
OK
application/json
get
GET /api/v1/employee HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*
200

OK

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "active": true,
    "status": {
      "current": "text",
      "changedAt": "2025-07-02T00:52:01.445Z",
      "changedBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "created": {
      "createdAt": "2025-07-02T00:52:01.445Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "emails": [
      {
        "email": "text",
        "primary": true
      }
    ],
    "groups": [
      {
        "entityType": "text",
        "entityId": "123e4567-e89b-12d3-a456-426614174000",
        "type": "text"
      }
    ],
    "managers": [
      {
        "managerId": "123e4567-e89b-12d3-a456-426614174000",
        "type": "text",
        "since": "2025-07-02T00:52:01.445Z"
      }
    ],
    "profile": {
      "employeeNumber": "text",
      "firstName": "text",
      "lastName": "text",
      "bio": "text",
      "profileImage": "text",
      "birthDate": "2025-07-02",
      "gender": "text",
      "timezone": "text",
      "location": "text",
      "joinDate": "2025-07-02",
      "companyRole": "text"
    },
    "account": "123e4567-e89b-12d3-a456-426614174000",
    "authentication": {
      "account": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-07-02T00:52:01.445Z",
      "email": "text",
      "role": "text"
    },
    "preferences": {
      "namespace": "text",
      "values": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "mappings": [
      {
        "app": "123e4567-e89b-12d3-a456-426614174000",
        "namespace": "text",
        "mappedId": "text",
        "reference": "text",
        "mappingData": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "mappingSecrets": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ]
  }
]

Create employee

post
Authorizations
Body
namestringRequired
emailstringRequired
accountstring · uuidOptional
rolestringOptional
Responses
201
Created
application/json
post
POST /api/v1/employee HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "name": "text",
  "email": "text",
  "account": "123e4567-e89b-12d3-a456-426614174000",
  "role": "text"
}
201

Created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-02T00:52:01.445Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-02T00:52:01.445Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "emails": [
    {
      "email": "text",
      "primary": true
    }
  ],
  "groups": [
    {
      "entityType": "text",
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text"
    }
  ],
  "managers": [
    {
      "managerId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "since": "2025-07-02T00:52:01.445Z"
    }
  ],
  "profile": {
    "employeeNumber": "text",
    "firstName": "text",
    "lastName": "text",
    "bio": "text",
    "profileImage": "text",
    "birthDate": "2025-07-02",
    "gender": "text",
    "timezone": "text",
    "location": "text",
    "joinDate": "2025-07-02",
    "companyRole": "text"
  },
  "account": "123e4567-e89b-12d3-a456-426614174000",
  "authentication": {
    "account": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2025-07-02T00:52:01.445Z",
    "email": "text",
    "role": "text"
  },
  "preferences": {
    "namespace": "text",
    "values": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

Get employee

get
Authorizations
Path parameters
employeestringRequired
Responses
200
OK
application/json
get
GET /api/v1/employee/{employee} HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-02T00:52:01.445Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-02T00:52:01.445Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "emails": [
    {
      "email": "text",
      "primary": true
    }
  ],
  "groups": [
    {
      "entityType": "text",
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text"
    }
  ],
  "managers": [
    {
      "managerId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "since": "2025-07-02T00:52:01.445Z"
    }
  ],
  "profile": {
    "employeeNumber": "text",
    "firstName": "text",
    "lastName": "text",
    "bio": "text",
    "profileImage": "text",
    "birthDate": "2025-07-02",
    "gender": "text",
    "timezone": "text",
    "location": "text",
    "joinDate": "2025-07-02",
    "companyRole": "text"
  },
  "account": "123e4567-e89b-12d3-a456-426614174000",
  "authentication": {
    "account": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2025-07-02T00:52:01.445Z",
    "email": "text",
    "role": "text"
  },
  "preferences": {
    "namespace": "text",
    "values": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

Update employee

patch
Authorizations
Path parameters
employeestringRequired
Body
namestringRequired
emailstringRequired
accountstring · uuidOptional
rolestringOptional
Responses
200
OK
application/json
patch
PATCH /api/v1/employee/{employee} HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "name": "text",
  "email": "text",
  "account": "123e4567-e89b-12d3-a456-426614174000",
  "role": "text"
}
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-02T00:52:01.445Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-02T00:52:01.445Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "emails": [
    {
      "email": "text",
      "primary": true
    }
  ],
  "groups": [
    {
      "entityType": "text",
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text"
    }
  ],
  "managers": [
    {
      "managerId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "since": "2025-07-02T00:52:01.445Z"
    }
  ],
  "profile": {
    "employeeNumber": "text",
    "firstName": "text",
    "lastName": "text",
    "bio": "text",
    "profileImage": "text",
    "birthDate": "2025-07-02",
    "gender": "text",
    "timezone": "text",
    "location": "text",
    "joinDate": "2025-07-02",
    "companyRole": "text"
  },
  "account": "123e4567-e89b-12d3-a456-426614174000",
  "authentication": {
    "account": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2025-07-02T00:52:01.445Z",
    "email": "text",
    "role": "text"
  },
  "preferences": {
    "namespace": "text",
    "values": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

Get employees by name

get
Authorizations
Path parameters
namestringRequired
Responses
200
OK
application/json
get
GET /api/v1/employee/by-name/{name} HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*
200

OK

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "active": true,
    "status": {
      "current": "text",
      "changedAt": "2025-07-02T00:52:01.445Z",
      "changedBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "created": {
      "createdAt": "2025-07-02T00:52:01.445Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "emails": [
      {
        "email": "text",
        "primary": true
      }
    ],
    "groups": [
      {
        "entityType": "text",
        "entityId": "123e4567-e89b-12d3-a456-426614174000",
        "type": "text"
      }
    ],
    "managers": [
      {
        "managerId": "123e4567-e89b-12d3-a456-426614174000",
        "type": "text",
        "since": "2025-07-02T00:52:01.445Z"
      }
    ],
    "profile": {
      "employeeNumber": "text",
      "firstName": "text",
      "lastName": "text",
      "bio": "text",
      "profileImage": "text",
      "birthDate": "2025-07-02",
      "gender": "text",
      "timezone": "text",
      "location": "text",
      "joinDate": "2025-07-02",
      "companyRole": "text"
    },
    "account": "123e4567-e89b-12d3-a456-426614174000",
    "authentication": {
      "account": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-07-02T00:52:01.445Z",
      "email": "text",
      "role": "text"
    },
    "preferences": {
      "namespace": "text",
      "values": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "mappings": [
      {
        "app": "123e4567-e89b-12d3-a456-426614174000",
        "namespace": "text",
        "mappedId": "text",
        "reference": "text",
        "mappingData": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "mappingSecrets": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ]
  }
]

List managers of employee

get
Authorizations
Path parameters
employeestringRequired
Responses
200
OK
application/json
get
GET /api/v1/employee/{employee}/managers HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*
200

OK

[
  {
    "managerId": "123e4567-e89b-12d3-a456-426614174000",
    "type": "text",
    "since": "2025-07-02T00:52:01.445Z"
  }
]

Set managers for employee

post
Authorizations
Path parameters
employeestringRequired
Body
managerIdstring · uuidRequired
typestringRequired
Responses
200
OK
application/json
post
POST /api/v1/employee/{employee}/managers HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "managerId": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text"
}
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-02T00:52:01.445Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-02T00:52:01.445Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "emails": [
    {
      "email": "text",
      "primary": true
    }
  ],
  "groups": [
    {
      "entityType": "text",
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text"
    }
  ],
  "managers": [
    {
      "managerId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "since": "2025-07-02T00:52:01.445Z"
    }
  ],
  "profile": {
    "employeeNumber": "text",
    "firstName": "text",
    "lastName": "text",
    "bio": "text",
    "profileImage": "text",
    "birthDate": "2025-07-02",
    "gender": "text",
    "timezone": "text",
    "location": "text",
    "joinDate": "2025-07-02",
    "companyRole": "text"
  },
  "account": "123e4567-e89b-12d3-a456-426614174000",
  "authentication": {
    "account": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2025-07-02T00:52:01.445Z",
    "email": "text",
    "role": "text"
  },
  "preferences": {
    "namespace": "text",
    "values": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

Remove manager from employee

delete
Authorizations
Path parameters
employeestringRequired
managerstringRequired
Responses
200
OK
delete
DELETE /api/v1/employee/{employee}/managers/{manager} HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*
200

OK

No content

Get employee profile

get
Authorizations
Path parameters
employeestringRequired
Responses
200
OK
application/json
get
GET /api/v1/employee/{employee}/profile HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*
200

OK

{
  "employeeNumber": "text",
  "firstName": "text",
  "lastName": "text",
  "bio": "text",
  "profileImage": "text",
  "birthDate": "2025-07-02",
  "gender": "text",
  "timezone": "text",
  "location": "text",
  "joinDate": "2025-07-02",
  "companyRole": "text"
}

Create or replace employee profile

post
Authorizations
Path parameters
employeestringRequired
Body
employeeNumberstringOptional
firstNamestringOptional
lastNamestringOptional
biostringOptional
profileImagestringOptional
birthDatestring · dateOptional
genderstringOptional
timezonestringOptional
locationstringOptional
joinDatestring · dateOptional
companyRolestringOptional
Responses
201
Created
application/json
post
POST /api/v1/employee/{employee}/profile HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 219

{
  "employeeNumber": "text",
  "firstName": "text",
  "lastName": "text",
  "bio": "text",
  "profileImage": "text",
  "birthDate": "2025-07-02",
  "gender": "text",
  "timezone": "text",
  "location": "text",
  "joinDate": "2025-07-02",
  "companyRole": "text"
}
201

Created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-02T00:52:01.445Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-02T00:52:01.445Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "emails": [
    {
      "email": "text",
      "primary": true
    }
  ],
  "groups": [
    {
      "entityType": "text",
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text"
    }
  ],
  "managers": [
    {
      "managerId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "since": "2025-07-02T00:52:01.445Z"
    }
  ],
  "profile": {
    "employeeNumber": "text",
    "firstName": "text",
    "lastName": "text",
    "bio": "text",
    "profileImage": "text",
    "birthDate": "2025-07-02",
    "gender": "text",
    "timezone": "text",
    "location": "text",
    "joinDate": "2025-07-02",
    "companyRole": "text"
  },
  "account": "123e4567-e89b-12d3-a456-426614174000",
  "authentication": {
    "account": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2025-07-02T00:52:01.445Z",
    "email": "text",
    "role": "text"
  },
  "preferences": {
    "namespace": "text",
    "values": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

Update employee profile

patch
Authorizations
Path parameters
employeestringRequired
Body
employeeNumberstringOptional
firstNamestringOptional
lastNamestringOptional
biostringOptional
profileImagestringOptional
birthDatestring · dateOptional
genderstringOptional
timezonestringOptional
locationstringOptional
joinDatestring · dateOptional
companyRolestringOptional
Responses
200
OK
application/json
patch
PATCH /api/v1/employee/{employee}/profile HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 219

{
  "employeeNumber": "text",
  "firstName": "text",
  "lastName": "text",
  "bio": "text",
  "profileImage": "text",
  "birthDate": "2025-07-02",
  "gender": "text",
  "timezone": "text",
  "location": "text",
  "joinDate": "2025-07-02",
  "companyRole": "text"
}
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-02T00:52:01.445Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-02T00:52:01.445Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "emails": [
    {
      "email": "text",
      "primary": true
    }
  ],
  "groups": [
    {
      "entityType": "text",
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text"
    }
  ],
  "managers": [
    {
      "managerId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "since": "2025-07-02T00:52:01.445Z"
    }
  ],
  "profile": {
    "employeeNumber": "text",
    "firstName": "text",
    "lastName": "text",
    "bio": "text",
    "profileImage": "text",
    "birthDate": "2025-07-02",
    "gender": "text",
    "timezone": "text",
    "location": "text",
    "joinDate": "2025-07-02",
    "companyRole": "text"
  },
  "account": "123e4567-e89b-12d3-a456-426614174000",
  "authentication": {
    "account": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2025-07-02T00:52:01.445Z",
    "email": "text",
    "role": "text"
  },
  "preferences": {
    "namespace": "text",
    "values": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

Get employee by account ID

get
Authorizations
Path parameters
accountIdstringRequired
Responses
200
OK
application/json
get
GET /api/v1/employee/by-account/{accountId} HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-02T00:52:01.445Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-02T00:52:01.445Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "emails": [
    {
      "email": "text",
      "primary": true
    }
  ],
  "groups": [
    {
      "entityType": "text",
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text"
    }
  ],
  "managers": [
    {
      "managerId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "since": "2025-07-02T00:52:01.445Z"
    }
  ],
  "profile": {
    "employeeNumber": "text",
    "firstName": "text",
    "lastName": "text",
    "bio": "text",
    "profileImage": "text",
    "birthDate": "2025-07-02",
    "gender": "text",
    "timezone": "text",
    "location": "text",
    "joinDate": "2025-07-02",
    "companyRole": "text"
  },
  "account": "123e4567-e89b-12d3-a456-426614174000",
  "authentication": {
    "account": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2025-07-02T00:52:01.445Z",
    "email": "text",
    "role": "text"
  },
  "preferences": {
    "namespace": "text",
    "values": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

List reports for manager

get
Authorizations
Path parameters
managerIdstringRequired
Query parameters
typestringOptional
Responses
200
OK
application/json
get
GET /api/v1/employee/by-manager/{managerId} HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*
200

OK

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "active": true,
    "status": {
      "current": "text",
      "changedAt": "2025-07-02T00:52:01.445Z",
      "changedBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "created": {
      "createdAt": "2025-07-02T00:52:01.445Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "emails": [
      {
        "email": "text",
        "primary": true
      }
    ],
    "groups": [
      {
        "entityType": "text",
        "entityId": "123e4567-e89b-12d3-a456-426614174000",
        "type": "text"
      }
    ],
    "managers": [
      {
        "managerId": "123e4567-e89b-12d3-a456-426614174000",
        "type": "text",
        "since": "2025-07-02T00:52:01.445Z"
      }
    ],
    "profile": {
      "employeeNumber": "text",
      "firstName": "text",
      "lastName": "text",
      "bio": "text",
      "profileImage": "text",
      "birthDate": "2025-07-02",
      "gender": "text",
      "timezone": "text",
      "location": "text",
      "joinDate": "2025-07-02",
      "companyRole": "text"
    },
    "account": "123e4567-e89b-12d3-a456-426614174000",
    "authentication": {
      "account": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-07-02T00:52:01.445Z",
      "email": "text",
      "role": "text"
    },
    "preferences": {
      "namespace": "text",
      "values": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "mappings": [
      {
        "app": "123e4567-e89b-12d3-a456-426614174000",
        "namespace": "text",
        "mappedId": "text",
        "reference": "text",
        "mappingData": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "mappingSecrets": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ]
  }
]

List organizations

get
Authorizations
Responses
200
OK
application/json
get
GET /api/v1/organization HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*
200

OK

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "active": true,
    "status": {
      "current": "text",
      "changedAt": "2025-07-02T00:52:01.445Z",
      "changedBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "created": {
      "createdAt": "2025-07-02T00:52:01.445Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "alias": "text",
    "owners": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "profile": {
      "logoUrl": "text",
      "timezone": "text",
      "location": "text",
      "countryCode": "text",
      "companySize": "text",
      "website": "text",
      "mission": "text"
    },
    "apps": [
      {
        "type": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "keys": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "secretBase64": "text",
        "limitToRole": "text"
      }
    ],
    "preferences": {
      "namespace": "text",
      "values": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "mappings": [
      {
        "app": "123e4567-e89b-12d3-a456-426614174000",
        "namespace": "text",
        "mappedId": "text",
        "reference": "text",
        "mappingData": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "mappingSecrets": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ]
  }
]

Create organization

post
Authorizations
Body
namestringRequired
aliasstringOptional
ownerEmailstringOptional
Responses
201
Created
application/json
post
POST /api/v1/organization HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "name": "text",
  "alias": "text",
  "ownerEmail": "text"
}
201

Created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-02T00:52:01.445Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-02T00:52:01.445Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "alias": "text",
  "owners": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "profile": {
    "logoUrl": "text",
    "timezone": "text",
    "location": "text",
    "countryCode": "text",
    "companySize": "text",
    "website": "text",
    "mission": "text"
  },
  "apps": [
    {
      "type": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "keys": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "secretBase64": "text",
      "limitToRole": "text"
    }
  ],
  "preferences": {
    "namespace": "text",
    "values": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

Update current organization

patch
Authorizations
Body
namestringRequired
aliasstringOptional
ownerEmailstringOptional
Responses
200
OK
application/json
patch
PATCH /api/v1/organization HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "name": "text",
  "alias": "text",
  "ownerEmail": "text"
}
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-02T00:52:01.445Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-02T00:52:01.445Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "alias": "text",
  "owners": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "profile": {
    "logoUrl": "text",
    "timezone": "text",
    "location": "text",
    "countryCode": "text",
    "companySize": "text",
    "website": "text",
    "mission": "text"
  },
  "apps": [
    {
      "type": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "keys": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "secretBase64": "text",
      "limitToRole": "text"
    }
  ],
  "preferences": {
    "namespace": "text",
    "values": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

Get organization by ID

get
Authorizations
Path parameters
organizationstringRequired
Responses
200
OK
application/json
get
GET /api/v1/organization/{organization} HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-02T00:52:01.445Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-02T00:52:01.445Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "alias": "text",
  "owners": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "profile": {
    "logoUrl": "text",
    "timezone": "text",
    "location": "text",
    "countryCode": "text",
    "companySize": "text",
    "website": "text",
    "mission": "text"
  },
  "apps": [
    {
      "type": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "keys": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "secretBase64": "text",
      "limitToRole": "text"
    }
  ],
  "preferences": {
    "namespace": "text",
    "values": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

Update organization by ID

patch
Authorizations
Path parameters
organizationstringRequired
Body
namestringRequired
aliasstringOptional
ownerEmailstringOptional
Responses
200
OK
application/json
patch
PATCH /api/v1/organization/{organization} HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "name": "text",
  "alias": "text",
  "ownerEmail": "text"
}
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-02T00:52:01.445Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-02T00:52:01.445Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "alias": "text",
  "owners": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "profile": {
    "logoUrl": "text",
    "timezone": "text",
    "location": "text",
    "countryCode": "text",
    "companySize": "text",
    "website": "text",
    "mission": "text"
  },
  "apps": [
    {
      "type": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "keys": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "secretBase64": "text",
      "limitToRole": "text"
    }
  ],
  "preferences": {
    "namespace": "text",
    "values": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

Get organization profile

get
Authorizations
Responses
200
OK
application/json
get
GET /api/v1/organization/profile HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*
200

OK

{
  "logoUrl": "text",
  "timezone": "text",
  "location": "text",
  "countryCode": "text",
  "companySize": "text",
  "website": "text",
  "mission": "text"
}

Create or replace organization profile

post
Authorizations
Body
logoUrlstringOptional
timezonestringOptional
locationstringOptional
countryCodestringOptional
companySizestringOptional
websitestringOptional
missionstringOptional
Responses
201
Created
application/json
post
POST /api/v1/organization/profile HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 130

{
  "logoUrl": "text",
  "timezone": "text",
  "location": "text",
  "countryCode": "text",
  "companySize": "text",
  "website": "text",
  "mission": "text"
}
201

Created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-02T00:52:01.445Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-02T00:52:01.445Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "alias": "text",
  "owners": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "profile": {
    "logoUrl": "text",
    "timezone": "text",
    "location": "text",
    "countryCode": "text",
    "companySize": "text",
    "website": "text",
    "mission": "text"
  },
  "apps": [
    {
      "type": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "keys": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "secretBase64": "text",
      "limitToRole": "text"
    }
  ],
  "preferences": {
    "namespace": "text",
    "values": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

Update organization profile

patch
Authorizations
Body
logoUrlstringOptional
timezonestringOptional
locationstringOptional
countryCodestringOptional
companySizestringOptional
websitestringOptional
missionstringOptional
Responses
200
OK
application/json
patch
PATCH /api/v1/organization/profile HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 130

{
  "logoUrl": "text",
  "timezone": "text",
  "location": "text",
  "countryCode": "text",
  "companySize": "text",
  "website": "text",
  "mission": "text"
}
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-02T00:52:01.445Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-02T00:52:01.445Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "alias": "text",
  "owners": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "profile": {
    "logoUrl": "text",
    "timezone": "text",
    "location": "text",
    "countryCode": "text",
    "companySize": "text",
    "website": "text",
    "mission": "text"
  },
  "apps": [
    {
      "type": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "keys": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "secretBase64": "text",
      "limitToRole": "text"
    }
  ],
  "preferences": {
    "namespace": "text",
    "values": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

Get organization profile by ID

get
Authorizations
Path parameters
organizationstringRequired
Responses
200
OK
application/json
get
GET /api/v1/organization/{organization}/profile HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*
200

OK

{
  "logoUrl": "text",
  "timezone": "text",
  "location": "text",
  "countryCode": "text",
  "companySize": "text",
  "website": "text",
  "mission": "text"
}

Create or replace profile for organization

post
Authorizations
Path parameters
organizationstringRequired
Body
logoUrlstringOptional
timezonestringOptional
locationstringOptional
countryCodestringOptional
companySizestringOptional
websitestringOptional
missionstringOptional
Responses
201
Created
application/json
post
POST /api/v1/organization/{organization}/profile HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 130

{
  "logoUrl": "text",
  "timezone": "text",
  "location": "text",
  "countryCode": "text",
  "companySize": "text",
  "website": "text",
  "mission": "text"
}
201

Created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-02T00:52:01.445Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-02T00:52:01.445Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "alias": "text",
  "owners": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "profile": {
    "logoUrl": "text",
    "timezone": "text",
    "location": "text",
    "countryCode": "text",
    "companySize": "text",
    "website": "text",
    "mission": "text"
  },
  "apps": [
    {
      "type": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "keys": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "secretBase64": "text",
      "limitToRole": "text"
    }
  ],
  "preferences": {
    "namespace": "text",
    "values": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

Update profile for organization

patch
Authorizations
Path parameters
organizationstringRequired
Body
logoUrlstringOptional
timezonestringOptional
locationstringOptional
countryCodestringOptional
companySizestringOptional
websitestringOptional
missionstringOptional
Responses
200
OK
application/json
patch
PATCH /api/v1/organization/{organization}/profile HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 130

{
  "logoUrl": "text",
  "timezone": "text",
  "location": "text",
  "countryCode": "text",
  "companySize": "text",
  "website": "text",
  "mission": "text"
}
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-02T00:52:01.445Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-02T00:52:01.445Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "alias": "text",
  "owners": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "profile": {
    "logoUrl": "text",
    "timezone": "text",
    "location": "text",
    "countryCode": "text",
    "companySize": "text",
    "website": "text",
    "mission": "text"
  },
  "apps": [
    {
      "type": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "keys": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "secretBase64": "text",
      "limitToRole": "text"
    }
  ],
  "preferences": {
    "namespace": "text",
    "values": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

Get organization by alias

get
Authorizations
Path parameters
aliasstringRequired
Responses
200
OK
application/json
get
GET /api/v1/organization/alias/{alias} HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-02T00:52:01.445Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-02T00:52:01.445Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "alias": "text",
  "owners": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "profile": {
    "logoUrl": "text",
    "timezone": "text",
    "location": "text",
    "countryCode": "text",
    "companySize": "text",
    "website": "text",
    "mission": "text"
  },
  "apps": [
    {
      "type": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "keys": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "secretBase64": "text",
      "limitToRole": "text"
    }
  ],
  "preferences": {
    "namespace": "text",
    "values": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

List organizations by app type

get
Authorizations
Path parameters
typestringRequired
Responses
200
OK
application/json
get
GET /api/v1/organization/by-app/{type} HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*
200

OK

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "active": true,
    "status": {
      "current": "text",
      "changedAt": "2025-07-02T00:52:01.445Z",
      "changedBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "created": {
      "createdAt": "2025-07-02T00:52:01.445Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "alias": "text",
    "owners": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "profile": {
      "logoUrl": "text",
      "timezone": "text",
      "location": "text",
      "countryCode": "text",
      "companySize": "text",
      "website": "text",
      "mission": "text"
    },
    "apps": [
      {
        "type": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "keys": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "secretBase64": "text",
        "limitToRole": "text"
      }
    ],
    "preferences": {
      "namespace": "text",
      "values": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "mappings": [
      {
        "app": "123e4567-e89b-12d3-a456-426614174000",
        "namespace": "text",
        "mappedId": "text",
        "reference": "text",
        "mappingData": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "mappingSecrets": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ]
  }
]

List organizations by app external ID

get
Authorizations
Path parameters
typestringRequired
externalIdstringRequired
Responses
200
OK
application/json
get
GET /api/v1/organization/by-app-id/{type}/{externalId} HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*
200

OK

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "active": true,
    "status": {
      "current": "text",
      "changedAt": "2025-07-02T00:52:01.445Z",
      "changedBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "created": {
      "createdAt": "2025-07-02T00:52:01.445Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "alias": "text",
    "owners": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "profile": {
      "logoUrl": "text",
      "timezone": "text",
      "location": "text",
      "countryCode": "text",
      "companySize": "text",
      "website": "text",
      "mission": "text"
    },
    "apps": [
      {
        "type": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "keys": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "secretBase64": "text",
        "limitToRole": "text"
      }
    ],
    "preferences": {
      "namespace": "text",
      "values": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "mappings": [
      {
        "app": "123e4567-e89b-12d3-a456-426614174000",
        "namespace": "text",
        "mappedId": "text",
        "reference": "text",
        "mappingData": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "mappingSecrets": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ]
  }
]

List organizations by app data

get
Authorizations
Path parameters
typestringRequired
keystringRequired
valuestringRequired
Responses
200
OK
application/json
get
GET /api/v1/organization/by-app-data/{type}/{key}/{value} HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*
200

OK

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "active": true,
    "status": {
      "current": "text",
      "changedAt": "2025-07-02T00:52:01.445Z",
      "changedBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "created": {
      "createdAt": "2025-07-02T00:52:01.445Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "alias": "text",
    "owners": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "profile": {
      "logoUrl": "text",
      "timezone": "text",
      "location": "text",
      "countryCode": "text",
      "companySize": "text",
      "website": "text",
      "mission": "text"
    },
    "apps": [
      {
        "type": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "keys": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "secretBase64": "text",
        "limitToRole": "text"
      }
    ],
    "preferences": {
      "namespace": "text",
      "values": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "mappings": [
      {
        "app": "123e4567-e89b-12d3-a456-426614174000",
        "namespace": "text",
        "mappedId": "text",
        "reference": "text",
        "mappingData": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "mappingSecrets": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ]
  }
]

List organizations by app secret

post
Authorizations
Path parameters
typestringRequired
keystringRequired
Body
anyOptional
Responses
200
OK
application/json
post
POST /api/v1/organization/by-app-secret/{type}/{key} HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
200

OK

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "active": true,
    "status": {
      "current": "text",
      "changedAt": "2025-07-02T00:52:01.445Z",
      "changedBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "created": {
      "createdAt": "2025-07-02T00:52:01.445Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "alias": "text",
    "owners": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "profile": {
      "logoUrl": "text",
      "timezone": "text",
      "location": "text",
      "countryCode": "text",
      "companySize": "text",
      "website": "text",
      "mission": "text"
    },
    "apps": [
      {
        "type": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "keys": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "secretBase64": "text",
        "limitToRole": "text"
      }
    ],
    "preferences": {
      "namespace": "text",
      "values": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "mappings": [
      {
        "app": "123e4567-e89b-12d3-a456-426614174000",
        "namespace": "text",
        "mappedId": "text",
        "reference": "text",
        "mappingData": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "mappingSecrets": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ]
  }
]

Create API key for organization

post
Authorizations
Body
namestringRequired
limitToRolestringOptional
Responses
201
Created
application/json
post
POST /api/v1/organization/keys HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "name": "text",
  "limitToRole": "text"
}
201

Created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-02T00:52:01.445Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-02T00:52:01.445Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "alias": "text",
  "owners": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "profile": {
    "logoUrl": "text",
    "timezone": "text",
    "location": "text",
    "countryCode": "text",
    "companySize": "text",
    "website": "text",
    "mission": "text"
  },
  "apps": [
    {
      "type": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "keys": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "secretBase64": "text",
      "limitToRole": "text"
    }
  ],
  "preferences": {
    "namespace": "text",
    "values": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

Create API key for org by ID

post
Authorizations
Path parameters
organizationstringRequired
Body
namestringRequired
limitToRolestringOptional
Responses
201
Created
application/json
post
POST /api/v1/organization/{organization}/keys HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "name": "text",
  "limitToRole": "text"
}
201

Created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-02T00:52:01.445Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-02T00:52:01.445Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "alias": "text",
  "owners": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "profile": {
    "logoUrl": "text",
    "timezone": "text",
    "location": "text",
    "countryCode": "text",
    "companySize": "text",
    "website": "text",
    "mission": "text"
  },
  "apps": [
    {
      "type": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "keys": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "secretBase64": "text",
      "limitToRole": "text"
    }
  ],
  "preferences": {
    "namespace": "text",
    "values": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

Delete API key for current organization

delete
Authorizations
Path parameters
keystringRequired
Responses
200
OK
application/json
delete
DELETE /api/v1/organization/keys/{key} HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-02T00:52:01.445Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-02T00:52:01.445Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "alias": "text",
  "owners": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "profile": {
    "logoUrl": "text",
    "timezone": "text",
    "location": "text",
    "countryCode": "text",
    "companySize": "text",
    "website": "text",
    "mission": "text"
  },
  "apps": [
    {
      "type": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "keys": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "secretBase64": "text",
      "limitToRole": "text"
    }
  ],
  "preferences": {
    "namespace": "text",
    "values": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

Delete API key by org ID

delete
Authorizations
Path parameters
organizationstringRequired
keystringRequired
Responses
200
OK
application/json
delete
DELETE /api/v1/organization/{organization}/keys/{key} HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-02T00:52:01.445Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-02T00:52:01.445Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "alias": "text",
  "owners": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "profile": {
    "logoUrl": "text",
    "timezone": "text",
    "location": "text",
    "countryCode": "text",
    "companySize": "text",
    "website": "text",
    "mission": "text"
  },
  "apps": [
    {
      "type": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "keys": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "secretBase64": "text",
      "limitToRole": "text"
    }
  ],
  "preferences": {
    "namespace": "text",
    "values": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

List groups

get
Authorizations
Query parameters
statusstringOptional
typestringOptional
Responses
200
OK
application/json
get
GET /api/v1/group HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*
200

OK

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "text",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "active": true,
    "status": {
      "current": "text",
      "changedAt": "2025-07-02T00:52:01.445Z",
      "changedBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "created": {
      "createdAt": "2025-07-02T00:52:01.445Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "profile": {
      "icon": "text",
      "description": "text"
    },
    "mappings": [
      {
        "app": "123e4567-e89b-12d3-a456-426614174000",
        "namespace": "text",
        "mappedId": "text",
        "reference": "text",
        "mappingData": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "mappingSecrets": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ],
    "groups": [
      {
        "entityType": "text",
        "entityId": "123e4567-e89b-12d3-a456-426614174000",
        "type": "text"
      }
    ],
    "members": [
      {
        "entityType": "text",
        "entityId": "123e4567-e89b-12d3-a456-426614174000",
        "type": "text",
        "since": "2025-07-02T00:52:01.445Z"
      }
    ]
  }
]

Create group

post
Authorizations
Body
namestringRequired
typestringRequired
Responses
201
Created
application/json
post
POST /api/v1/group HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "name": "text",
  "type": "text"
}
201

Created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-02T00:52:01.445Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-02T00:52:01.445Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "profile": {
    "icon": "text",
    "description": "text"
  },
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "groups": [
    {
      "entityType": "text",
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text"
    }
  ],
  "members": [
    {
      "entityType": "text",
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "since": "2025-07-02T00:52:01.445Z"
    }
  ]
}

Get group

get
Authorizations
Path parameters
idstringRequired
Responses
200
OK
application/json
get
GET /api/v1/group/{id} HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-02T00:52:01.445Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-02T00:52:01.445Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "profile": {
    "icon": "text",
    "description": "text"
  },
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "groups": [
    {
      "entityType": "text",
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text"
    }
  ],
  "members": [
    {
      "entityType": "text",
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "since": "2025-07-02T00:52:01.445Z"
    }
  ]
}

Update group

patch
Authorizations
Path parameters
idstringRequired
Body
namestringRequired
typestringRequired
Responses
200
OK
application/json
patch
PATCH /api/v1/group/{id} HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "name": "text",
  "type": "text"
}
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-02T00:52:01.445Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-02T00:52:01.445Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "profile": {
    "icon": "text",
    "description": "text"
  },
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "groups": [
    {
      "entityType": "text",
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text"
    }
  ],
  "members": [
    {
      "entityType": "text",
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "since": "2025-07-02T00:52:01.445Z"
    }
  ]
}

Get group profile

get
Authorizations
Path parameters
groupstringRequired
Responses
200
OK
application/json
get
GET /api/v1/group/{group}/profile HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*
200

OK

{
  "icon": "text",
  "description": "text"
}

Create or replace group profile

post
Authorizations
Path parameters
groupstringRequired
Body
iconstringOptional
descriptionstringOptional
Responses
201
Created
application/json
post
POST /api/v1/group/{group}/profile HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "icon": "text",
  "description": "text"
}
201

Created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-02T00:52:01.445Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-02T00:52:01.445Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "profile": {
    "icon": "text",
    "description": "text"
  },
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "groups": [
    {
      "entityType": "text",
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text"
    }
  ],
  "members": [
    {
      "entityType": "text",
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "since": "2025-07-02T00:52:01.445Z"
    }
  ]
}

Update group profile

patch
Authorizations
Path parameters
groupstringRequired
Body
iconstringOptional
descriptionstringOptional
Responses
200
OK
application/json
patch
PATCH /api/v1/group/{group}/profile HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "icon": "text",
  "description": "text"
}
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-02T00:52:01.445Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-02T00:52:01.445Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "profile": {
    "icon": "text",
    "description": "text"
  },
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "groups": [
    {
      "entityType": "text",
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text"
    }
  ],
  "members": [
    {
      "entityType": "text",
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "since": "2025-07-02T00:52:01.445Z"
    }
  ]
}

List group members

get
Authorizations
Path parameters
groupIdstringRequired
Query parameters
entitystringOptional
membershipstringOptional
Responses
200
OK
application/json
get
GET /api/v1/group/{groupId}/members HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*
200

OK

[
  {
    "entityId": "123e4567-e89b-12d3-a456-426614174000",
    "type": "text",
    "organization": "123e4567-e89b-12d3-a456-426614174000"
  }
]
PreviousOverviewNextOKRs