Get team member summary

GET /v2/teams/{team_nanoid}/member/{user_nanoid}/summary

Try it

Get team member summary

cURL

curl --request GET \
  --url https://b2b-api.dev-riseworks.io/v2/teams/{team_nanoid}/member/{user_nanoid}/summary \
  --header 'Authorization: Bearer <token>'

200

{
  "success": true,
  "data": {
    "user": {
      "nanoid": "<string>",
      "avatar": "<string>",
      "first_name": "<string>",
      "middle_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "blockchain_address": "<string>",
      "phone": "<string>",
      "dob": "<string>",
      "address": {
        "line_1": "<string>",
        "line_2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "<string>",
        "zip_code": "<string>",
        "timezone": "<string>"
      },
      "social": {
        "linkedin": "<string>",
        "discord": "<string>",
        "website": "<string>",
        "x": "<string>"
      },
      "certifications": [
        {
          "nanoid": "<string>",
          "title": "<string>",
          "website": "<string>",
          "year": 123,
          "file": "<string>"
        }
      ],
      "onboarding": {
        "onboarded": true,
        "step": "complete",
        "role": "admin",
        "moderation_status": "approved"
      }
    },
    "relationship_type": "team_employee",
    "pay_schedules": [
      {
        "nanoid": "<string>",
        "type": "milestone",
        "amount": "<string>",
        "payments_amount": 123,
        "start_date": "2023-11-07T05:31:56Z",
        "end_date": "2023-11-07T05:31:56Z"
      }
    ],
    "company": {
      "nanoid": "<string>",
      "avatar": "<string>",
      "name": "<string>",
      "website": "<string>",
      "blockchain_address": "<string>",
      "address": {
        "line_1": "<string>",
        "line_2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "<string>",
        "zip_code": "<string>",
        "timezone": "<string>"
      },
      "admin_contact": {
        "fullname": "<string>",
        "phone": "<string>",
        "email": "<string>"
      },
      "incorporation_country": "<string>",
      "incorporation_type": "association",
      "private_data": {
        "tax_id": "<string>"
      }
    }
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

team_nanoid · string · required

TeamNanoid

Required string length: 15

user_nanoid · string · required

UserNanoid

Required string length: 15

Response

200

application/json

Default Response

success · enum<boolean> · required

Available options: true, false

data · object · required

Show child attributes

data. user · object · required

Show child attributes

data.user. nanoid · string · required

Unique identifier for the user

Required string length: 15

data.user. avatar · string · required

URL of the user's avatar

data.user. first_name · string · required

User's first name

data.user. middle_name · string · required

User's middle name

data.user. last_name · string · required

User's last name

data.user. email · string · required

User's email address

data.user. blockchain_address · string · required

User's blockchain wallet address

data.user. phone · string · required

User's phone number

data.user. dob · string | null · required

User's date of birth, nullable

data.user. address · object · required

Show child attributes

data.user.address. line_1 · string · required

Primary address line

data.user.address. line_2 · string · required

Secondary address line

data.user.address. city · string · required

City of residence

data.user.address. state · string · required

State or region

data.user.address. country · string · required

Country of residence

data.user.address. zip_code · string · required

Postal code

data.user.address. timezone · string · required

User's timezone

data.user. social · object · required

Show child attributes

data.user.social. linkedin · string · required

User's LinkedIn profile URL

data.user.social. discord · string · required

User's Discord handle

data.user.social. website · string · required

User's personal website

data.user.social. x · string · required

User's handle on platform X

data.user. certifications · object[] · required

List of user's certifications

Show child attributes

data.user.certifications. nanoid · string · required

Unique identifier for the certification

Required string length: 15

data.user.certifications. title · string · required

Title of the certification

data.user.certifications. website · string · required

Website URL for certification details

data.user.certifications. year · number · required

Year the certification was obtained

data.user.certifications. file · string · required

URL of the file related to the certification

data.user. onboarding · object · required

Show child attributes

data.user.onboarding. onboarded · boolean · required

Indicates whether the user is onboarded

data.user.onboarding. step · enum<string> | null · required

Current onboarding step, nullable

Available options: complete, compliance_process, details, initial, riseid, security, signer, signing, v1_migration_in_progress, v1_migration_need_rsk

data.user.onboarding. role · enum<string> | null · required

User's role during onboarding, nullable

Available options: admin, payee, payer, viewer

data.user.onboarding. moderation_status · enum<string> | null · required

Moderation status during onboarding, nullable

Available options: approved, pending, rejected, submitted

data. relationship_type · enum<string> · required

Type of relationship with the team

Available options: team_employee, contractor

data. pay_schedules · object[] · required

List of pay schedules associated with the user

Show child attributes

data.pay_schedules. nanoid · string · required

Unique identifier for the pay schedule

Required string length: 15

data.pay_schedules. type · enum<string> · required

Type of pay schedule

Available options: milestone, recurring

data.pay_schedules. amount · string · required

Payment amount

data.pay_schedules. payments_amount · number · required

Total number of payments

data.pay_schedules. start_date · required

Start date of the pay schedule

data.pay_schedules. end_date · required

End date of the pay schedule

data. company · object

Details of the associated company, optional

Show child attributes

data.company. nanoid · string · required

Unique identifier for the company

Required string length: 15

data.company. avatar · string · required

URL of the company's avatar

data.company. name · string · required

Company's name

data.company. website · string · required

Company's website URL

data.company. blockchain_address · string · required

Company's blockchain wallet address

data.company. address · object · required

Show child attributes

data.company.address. line_1 · string · required

Primary address line

data.company.address. line_2 · string · required

Secondary address line

data.company.address. city · string · required

City of the company

data.company.address. state · string · required

State or region

data.company.address. country · string · required

Country of the company

data.company.address. zip_code · string · required

Postal code

data.company.address. timezone · string · required

Company's timezone

data.company. admin_contact · object · required

Contact information for the company administrator

Show child attributes

data.company.admin_contact. fullname · string · required

Administrator's full name

data.company.admin_contact. phone · string · required

Administrator's phone number

data.company.admin_contact. email · string · required

Administrator's email address

data.company. incorporation_country · string · required

Country of incorporation

data.company. incorporation_type · enum<string> · required

Type of incorporation

Available options: association, c-corporation, charitable_incorporated_organisation, chartered_company, holding_company, im_not_sure, limited_liability_company, limited_partnership, non_government_organisation, non_profit_organisation, private_limited_company, public_limited_company, s-corporation, sole_proprietorship, statutory_company, subsidiary_company, unlimited_partnership

data.company. private_data · object · required

Show child attributes

data.company.private_data. tax_id · string · required

Company's tax identification number